| Up to higher level directory | |||
| Name | Date | Size | |
|---|---|---|---|
| examples/ | 01-Nov-2013 | ||
| OWNERS | 01-Nov-2013 | 190 | |
| README | 01-Nov-2013 | 3.4K | |
| server2/ | 01-Nov-2013 | ||
| static/ | 01-Nov-2013 | ||
| templates/ | 01-Nov-2013 | ||
README
1 -------- 2 Overview 3 4 This is the content and its server for the extensions/apps documentation served 5 from http://developer.chrome.com/(extensions|apps). 6 7 Documentation for apps and extensions are partly generated from API definitions 8 (for the reference material), and partly hand-written. 9 10 All documentation sources are checked into source control, just like any other 11 Chrome source code. The server consumes these sources and generates the 12 documentation web pages dynamically. 13 14 The goals of this system are: 15 16 * Docs are generated from API definitions; it isn't possible to add or modify 17 APIs without creating stub reference documentation at the same time. 18 19 * Docs are editable by anyone with Chrome commit access. This encourages 20 developers to do their part to keep doc up to date, and allows part-time 21 contributors to help too. 22 23 * Docs go live automatically and immediately, upon check-in. There's no separate 24 push process for docs. 25 26 * Docs are branched automatically with Chrome's source code; the docs for each 27 Chrome release are kept with the corresponding source code. 28 29 * Users can always find the current doc for any Chrome release channel (i.e., 30 /trunk/extensions/, /beta/apps/, etc.). These URLs are updated automatically 31 with Chrome's release process. 32 33 34 ------------ 35 Editing docs 36 37 1. Edit files. 38 39 - If you are not updating the static HTML for a docs page, you will most 40 likely not have to do anything. The docs server will automatically pick 41 up changes to the JSON or IDL schemas. 42 43 - Otherwise, they will be in chrome/common/extensions/docs/templates/. 44 See the "Overview of directories" section for more information. 45 Chances are you'll want to change a file in either "intros" (if changing 46 API documentation) or "articles" (if changing non-API documentation). 47 If adding files or APIs you'll also need to add something to "public". 48 49 - Files in templates directory use the Handlebar template language. It is 50 extremely simple, essentially: write HTML. 51 See third_party/handlebar/README.md. 52 53 2. Run 'server2/preview.py' 54 55 3. Check your work at http://localhost:8000/(apps|extensions)/<doc_name> 56 57 4. Upload patch and offer reviewers a preview link at a URL with your patch 58 number and files, similar to: 59 https://chrome-apps-doc.appspot.com/_patch/12345678/apps/index.html 60 https://chrome-apps-doc.appspot.com/_patch/12345678/extensions/index.html 61 62 5. Commit files as with any other Chrome change. The live server will update 63 within 5-10 minutes. 64 65 66 ----------------------- 67 Overview of directories 68 69 * examples: The source for the sample extensions. Note that the sample apps are 70 checked into github at https://github.com/GoogleChrome/chrome-app-samples. 71 72 * server2: The Python AppEngine server which serves all the content (living at 73 developer.chrome.com). Unless you're developing the server itself, you won't 74 need to worry about this (and if you are, see the README in there). 75 76 * static: The static content (images, CSS, JavaScript, etc). 77 78 * templates: These are the templates that server2 interprets and generates HTML 79 content with. This has four subdirectories: 80 - intros: The static content that appears before the API reference on API 81 pages. 82 - articles: The static content that appears on non-API pages. 83 - public: The top level templates for all pages. 84 - private: Helper templates used in rendering the docs. 85 86 87 -------------------- 88 The AppEngine server 89 90 See server2/README. 91
