OLD | NEW |
1 // === Overview === | 1 // === Overview === |
2 // | 2 // |
3 // This file configures where to find and how to serve content in the docserver. | 3 // This file configures where to find and how to serve content in the docserver. |
4 // It's the most fundamentally important file in all of the docserver. | 4 // It's the most fundamentally important file in all of the docserver. |
5 // | 5 // |
6 // === Format === | 6 // === Format === |
7 // | 7 // |
8 // Each entry declares a rule with: | 8 // Each entry declares a rule with: |
9 // * An arbitrary identifier key e.g. "cr-extensions-examples". | 9 // * An arbitrary identifier key e.g. "cr-extensions-examples". |
10 // * What URL the rule should be invoked with, given by "serveFrom", e.g. | 10 // * What URL the rule should be invoked with, given by "serveFrom", e.g. |
11 // "extensions/examples". | 11 // "extensions/examples". |
12 // * An object describing where the content originates, either "chromium" | 12 // * An object describing where the content originates, either "chromium", |
13 // or "github". | 13 // "github", or "gcs". |
14 // * "chromium" must provide a "dir" value specifying which chromium directory | 14 // * "chromium" must provide a "dir" value specifying which chromium directory |
15 // to look in, e.g. "extensions/samples". | 15 // to look in, e.g. "extensions/samples". |
16 // * "github" must provide "owner" and "repo" values specifying the owner of | 16 // * "github" must provide "owner" and "repo" values specifying the owner of |
17 // the GitHub repository, and the repository name, e.g. "GoogleChrome" and | 17 // the GitHub repository, and the repository name, e.g. "GoogleChrome" and |
18 // "chrome-app-samples" respectively. | 18 // "chrome-app-samples" respectively. |
19 // | 19 // |
20 // In the chromium example, when the user navigates to | 20 // In the chromium example, when the user navigates to |
21 // | 21 // |
22 // developer.chrome.com/extensions/examples/some/sample/path | 22 // developer.chrome.com/extensions/examples/some/sample/path |
23 // | 23 // |
(...skipping 10 matching lines...) Expand all Loading... |
34 // There are some other properties that can be specified: | 34 // There are some other properties that can be specified: |
35 // * "supportsZip" indicates whether directories are allowed to be served as | 35 // * "supportsZip" indicates whether directories are allowed to be served as |
36 // zip files. For safety this isn't supported for arbitrary URLs, only those | 36 // zip files. For safety this isn't supported for arbitrary URLs, only those |
37 // within a rule that has "supportsZip": true. | 37 // within a rule that has "supportsZip": true. |
38 // * "supportsTemplates" indicates whether HTML files should be treated and | 38 // * "supportsTemplates" indicates whether HTML files should be treated and |
39 // renderered as templates, versus just plain text. Complex documentation | 39 // renderered as templates, versus just plain text. Complex documentation |
40 // which interacts with docserver features (like API listing) need to set | 40 // which interacts with docserver features (like API listing) need to set |
41 // this to true. Otherwise, it's safer and more efficient to omit it. | 41 // this to true. Otherwise, it's safer and more efficient to omit it. |
42 | 42 |
43 { | 43 { |
44 "cr-chrome-docs-home-gitiles": { | |
45 "gitiles": { | |
46 "dir": "chrome/docs" | |
47 }, | |
48 "defaultExtensions": [".html", ".md"], | |
49 "serveFrom": "home-gitiles", | |
50 "supportsTemplates": true | |
51 }, | |
52 "cr-chrome-docs-home": { | 44 "cr-chrome-docs-home": { |
53 "chromium": { | 45 "chromium": { |
54 "dir": "chrome/docs" | 46 "dir": "chrome/docs" |
55 }, | 47 }, |
56 "defaultExtensions": [".html", ".md"], | 48 "defaultExtensions": [".html", ".md"], |
57 "serveFrom": "home", | 49 "serveFrom": "home", |
58 "supportsTemplates": true | 50 "supportsTemplates": true |
59 }, | 51 }, |
60 "cr-extensions-examples": { | 52 "cr-extensions-examples": { |
61 "chromium": { | 53 "chromium": { |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
104 }, | 96 }, |
105 "webstore-docs": { | 97 "webstore-docs": { |
106 "defaultExtensions": [".html", ".md"], | 98 "defaultExtensions": [".html", ".md"], |
107 "gcs": { | 99 "gcs": { |
108 "bucket": "gs://chromedocs-webstore" | 100 "bucket": "gs://chromedocs-webstore" |
109 }, | 101 }, |
110 "serveFrom": "webstore", | 102 "serveFrom": "webstore", |
111 "supportsTemplates": true | 103 "supportsTemplates": true |
112 } | 104 } |
113 } | 105 } |
OLD | NEW |