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

Side by Side Diff: chrome/common/extensions/docs/server2/README

Issue 10831225: Extensions Docs Server: Update README (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Overview 1 Overview
2 2
3 This is a new iteration of the Chrome extension and app documentation 3 This is a new iteration of the Chrome extension and app documentation
4 server. It will replace the existing doc build system described in 4 server. It will replace the existing doc build system described in
5 ../README.txt. 5 ../README.txt.
6 6
7 As with the previous version, the goals of the system are: 7 As with the previous version, the goals of the system are:
8 8
9 * Docs are generated from API definitions; it isn't possible to add or 9 * Docs are generated from API definitions; it isn't possible to add or
10 modify APIs without creating stub reference documentation at the same 10 modify APIs without creating stub reference documentation at the same
11 time. 11 time.
12 * Docs are editable by anyone with Chrome commit access. Docs go live 12 * Docs are editable by anyone with Chrome commit access. Docs go live
13 automatically and immediately. 13 automatically and immediately.
14 * Docs are branched automatically with Chrome's source code; it's 14 * Docs are branched automatically with Chrome's source code; it's
15 always possible to see the current doc for any Chrome release channel. 15 always possible to see the current doc for any Chrome release channel.
16 16
17 The main difference from the previous iteration is that this server 17 The main difference from the previous iteration is that this server
18 implements all the generation dynamically on the server, thus 18 implements all the generation dynamically on the server, thus
19 eliminating the need for annoying and error-prone generation step at 19 eliminating the need for annoying and error-prone generation step at
20 commit time. 20 commit time.
21 21
22 How to Use 22
23 Viewing the Docs
24
25 The preview server allows easy viewing of the docs. To run the preview server:
26
27 1. Run './preview.py'
28
29 2. View docs at http://localhost:8000/(apps|extensions)/<doc_name>
30
31
32 Developing the Server
33
34 To run the server in the App Engine environment, follow these steps:
23 35
24 1. Download the python Google App Engine SDK from: 36 1. Download the python Google App Engine SDK from:
25 https://developers.google.com/appengine/downloads 37 https://developers.google.com/appengine/downloads
26 38
27 2. Run 'start_dev_server.py <path/to/dev_appserver.py>' 39 2. Run './start_dev_server.py <path/to/dev_appserver.py>'
28 (dev_appserver.py is part of the App Engine) 40 (dev_appserver.py is part of the App Engine)
29 41
30 3. View docs at http://localhost:8080 42 3. View docs at http://localhost:8080/(apps|extensions)/<doc_name>
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698