README
1 --------
2 Overview
3
4 This is a Google App Engine server which serves the documentation for Chrome
5 apps and extensions. At time of this writing, the primary URL is:
6 http://developer.chrome.com/.
7
8
9 ---------------------
10 Developing the Server
11
12 You shouldn't need app engine locally to develop the server, preview.py should
13 be 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 --------------------
25 Deploying the Server
26
27 You will need to have access to the http://chrome-apps-doc.appspot.com app.
28 Contact aa (a] chromium.org, erikkay (a] chromium.org, miket (a] chromium.org,
29 kalman (a] chromium.org, or ernestd (a] chromium.org to obtain access.
30
31 Once you have access:
32
33 1. Increment the version in app.yaml so we can roll back if the update breaks.
34
35 2. Run build_server.py. This copies some depenencies from /third_party into the
36 server directory so that they get uploaded to App Engine.
37
38 3. Run appcfg.py (supplied with the App Engine SDK) to upload the server code:
39
40 appcfg.py update .
41
42 4. When prompted for your credentials, enter the information for the account
43 that has access to the production app.
44
45 5. Go to http://www.appspot.com, select the docs project, click "versions" in
46 the sidebar, and make the version you just deployed the "default" version.
47
48 If you get an error about too many versions when deploying, go into this
49 view and delete the version which was deployed the longest time ago. Then
50 try to deploy again.
51