OLD | NEW |
1 -------- | 1 -------- |
2 Overview | 2 Overview |
3 | 3 |
4 This is the content and its server for the extensions/apps documentation served | 4 This is the content and its server for the extensions/apps documentation served |
5 from http://developer.chrome.com/(extensions|apps). | 5 from http://developer.chrome.com/(extensions|apps). |
6 | 6 |
7 Documentation for apps and extensions are partly generated from API definitions | 7 Documentation for apps and extensions are partly generated from API definitions |
8 (for the reference material), and partly hand-written. | 8 (for the reference material), and partly hand-written. |
9 | 9 |
10 All documentation sources are checked into source control, just like any other | 10 All documentation sources are checked into source control, just like any other |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
43 - Otherwise, they will be in chrome/common/extensions/docs/templates/. | 43 - Otherwise, they will be in chrome/common/extensions/docs/templates/. |
44 See the "Overview of directories" section for more information. | 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 | 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). | 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". | 47 If adding files or APIs you'll also need to add something to "public". |
48 | 48 |
49 - Files in templates directory use the Handlebar template language. It is | 49 - Files in templates directory use the Handlebar template language. It is |
50 extremely simple, essentially: write HTML. | 50 extremely simple, essentially: write HTML. |
51 See third_party/handlebar/README.md. | 51 See third_party/handlebar/README.md. |
52 | 52 |
| 53 - static/css/out/site.css is generated by compiling static/sass/*.scss |
| 54 files. Don't change site.css directly. Instead, change the *.scss files |
| 55 and run compass from this (docs/) directory: |
| 56 compass compile . |
| 57 See http://compass-style.org/install to install compass. |
| 58 |
53 2. Run 'server2/preview.py' | 59 2. Run 'server2/preview.py' |
54 | 60 |
55 3. Check your work at http://localhost:8000/(apps|extensions)/<doc_name> | 61 3. Check your work at http://localhost:8000/(apps|extensions)/<doc_name> |
56 | 62 |
57 4. Upload patch and offer reviewers a preview link at a URL with your patch | 63 4. Upload patch and offer reviewers a preview link at a URL with your patch |
58 number and files, similar to: | 64 number and files, similar to: |
59 https://chrome-apps-doc.appspot.com/_patch/12345678/apps/index.html | 65 https://chrome-apps-doc.appspot.com/_patch/12345678/apps/index.html |
60 https://chrome-apps-doc.appspot.com/_patch/12345678/extensions/index.html | 66 https://chrome-apps-doc.appspot.com/_patch/12345678/extensions/index.html |
61 | 67 |
62 5. Commit files as with any other Chrome change. The live server will update | 68 5. Commit files as with any other Chrome change. The live server will update |
(...skipping 18 matching lines...) Expand all Loading... |
81 pages. | 87 pages. |
82 - articles: The static content that appears on non-API pages. | 88 - articles: The static content that appears on non-API pages. |
83 - public: The top level templates for all pages. | 89 - public: The top level templates for all pages. |
84 - private: Helper templates used in rendering the docs. | 90 - private: Helper templates used in rendering the docs. |
85 | 91 |
86 | 92 |
87 -------------------- | 93 -------------------- |
88 The AppEngine server | 94 The AppEngine server |
89 | 95 |
90 See server2/README. | 96 See server2/README. |
OLD | NEW |