Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(3472)

Unified Diff: chrome/common/extensions/docs/server2/README

Issue 10885049: Extensions Docs Server: KILL BUILD.PY (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: better Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/common/extensions/docs/build/build.py ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/server2/README
diff --git a/chrome/common/extensions/docs/server2/README b/chrome/common/extensions/docs/server2/README
index 6493111a30b4f378d5d73ba564b6aaf1ff70583a..8734f97b7000c98e29d563af5be1d48710d11d1b 100644
--- a/chrome/common/extensions/docs/server2/README
+++ b/chrome/common/extensions/docs/server2/README
@@ -35,11 +35,17 @@ Editing Docs
1. Edit files.
- - They will mostly be in chrome/common/extensions/api/ or
- chrome/common/extensions/docs/server2/templates/.
+ - If you are not updating the static HTML for a docs page, you will most
+ likely not have to do anything. The docs server will automatically pick
+ up changes to the JSON or IDL schemas.
+
+ - Otherwise, they will be in
+ chrome/common/extensions/docs/server2/templates/. See the
+ "Overview of ./tempaltes Directory" section for more information.
- Files in templates directory use the Handlebar template language. It is
- extremely simple. See third_party/handlebar/README.md.
+ extremely simple, essentially: write HTML.
+ See third_party/handlebar/README.md.
2. Run './preview.py'
@@ -49,6 +55,20 @@ Editing Docs
server will update within 5-10 minutes.
+Overview of ./templates Directory
+
+The ./templates directory has four subdirectories.
+
+ - intros -> The static content that appears before the API reference on API
+ pages.
+
+ - articles -> The static content that appears on non-API pages.
+
+ - public -> The top level templates for all pages.
+
+ - private -> Helper templates used in rendering the docs.
+
+
Developing the Server
You shouldn't need app engine locally to develop the server, preview.py should
« no previous file with comments | « chrome/common/extensions/docs/build/build.py ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698