README revision 5821806d5e7f356e8fa4b058a389a808ea183019
1--------
2Overview
3
4This is a Google App Engine server which serves the documentation for Chrome
5apps and extensions. At time of this writing, the primary URL is:
6http://developer.chrome.com/.
7
8
9---------------------
10Developing the Server
11
12You shouldn't need app engine locally to develop the server, preview.py should
13be sufficient. If for some reason you want to test against the app engine SDK:
14
15  1. Download the python Google App Engine SDK from:
16     https://developers.google.com/appengine/downloads
17
18  2. Run './start_dev_server.py <path/to/dev_appserver.py>'
19     (dev_appserver.py is part of the App Engine)
20
21  3. View docs at http://localhost:8080/(apps|extensions)/<doc_name>
22
23
24--------------------
25Deploying the Server
26
27You will need to have access to the http://chrome-apps-doc.appspot.com app.
28Contact aa@chromium.org, erikkay@chromium.org, mihaip@chromium.org,
29miket@chromium.org, kalman@chromium.org, or ernestd@chromium.org to obtain
30access.
31
32Once you have access:
33
341. Increment the version in app.yaml so we can roll back if the update breaks.
35
362. Run build_server.py. This copies some depenencies from /third_party into the
37   server directory so that they get uploaded to App Engine.
38
393. Run appcfg.py (supplied with the App Engine SDK) to upload the server code:
40
41    appcfg.py update .
42
434. When prompted for your credentials, enter the information for the account
44   that has access to the production app.
45
465. Go to http://www.appspot.com, select the docs project, click "versions" in
47   the sidebar, and make the version you just deployed the "default" version.
48
49   If you get an error about too many versions when deploying, go into this
50   view and delete the version which was deployed the longest time ago.  Then
51   try to deploy again.
52