Extensions Docs Server: KILL BUILD.PY

chrome/common/extensions/docs/server2/README

 Overview
 
 This is a Google App Engine server which serves the documentation for Chrome
 apps and extensions. At time of this writing, the primary URL is:
 http://developer.chrome.com/.
 
 Documentation for Chrome apps and extensions is partly generated from API
 definitions (for the reference material), and partly hand-written.
 
 All documentation sources are checked into source control, just like any other
@@ skipping 17 matching lines @@
 
 * Users can always find the current doc for any Chrome release channel (i.e.,
   /trunk/extensions/, /beta/apps/, etc.). These URLs are updated automatically
   with Chrome's release process.
 
 
 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 mostly be in chrome/common/extensions/api/ or

[not at google - send to devlin, 2012/08/30 02:12:08]

what is in chrome/common/extensions/api ?

[cduvall, 2012/08/30 02:19:11]

Done.

+       chrome/common/extensions/docs/server2/templates/. See the
+       "Overview of ./tempalates Directory" section for more information.

[not at google - send to devlin, 2012/08/30 02:12:08]

templates

[cduvall, 2012/08/30 02:19:11]

Done.

 
      - Files in templates directory use the Handlebar template language. It is
        extremely simple. See third_party/handlebar/README.md.
 
   2. Run './preview.py'
 
   3. Check your work at http://localhost:8000/(apps|extensions)/<doc_name>
 
   4. Send a CL and commit files as with any other Chrome change. The live
      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.
+

[not at google - send to devlin, 2012/08/30 02:12:08]

We should explain what a "template" means somewhere. E.g. it's plain HTML with
special tags (point at handlebar github for documentation).

(Which means I'll need to update the documentation.)

[cduvall, 2012/08/30 02:19:11]

line 46

+
 Developing the Server
 
 You shouldn't need app engine locally to develop the server, preview.py should
 be sufficient. If for some reason you want to test against the app engine SDK:
 
   1. Download the python Google App Engine SDK from:
      https://developers.google.com/appengine/downloads
 
   2. Run './start_dev_server.py <path/to/dev_appserver.py>'
      (dev_appserver.py is part of the App Engine)
@@ skipping 20 matching lines @@
 
 4. When prompted for your credentials, enter the information for the account
    that has access to the production app.
 
 5. Go to http://www.appspot.com, select the docs project, click "versions" in
    the sidebar, and make the version you just deployed the "default" version.
 
    If you get an error about too many versions when deploying, go into this
    view and delete the version which was deployed the longest time ago.  Then
    try to deploy again.