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.
8 // Each entry declares a rule with:
9 // * An arbitrary identifier key e.g. "cr-extensions-examples".
10 // * What URL the rule should be invoked with, given by "serveFrom", e.g.
11 // "extensions/examples".
12 // * An object describing where the content originates, either "chromium"
14 // * "chromium" must provide a "dir" value specifying which chromium directory
15 // to look in, e.g. "extensions/samples".
16 // * "github" must provide "owner" and "repo" values specifying the owner of
17 // the GitHub repository, and the repository name, e.g. "GoogleChrome" and
18 // "chrome-app-samples" respectively.
20 // In the chromium example, when the user navigates to
22 // developer.chrome.com/extensions/examples/some/sample/path
25 // 1. The "cr-extensions-examples" rule is invoked (since it's served from
26 // "extensions/examples").
27 // 2. The docserver will look up the path "docs/examples/some/sample/path"
28 // in chromium - the URL after the "serveFrom" path (some/sample/path)
29 // prefixed by the chromium directory (docs/examples).
30 // 3. Then render and serve it.
32 // === Special properties ===
34 // There are some other properties that can be specified:
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
37 // within a rule that has "supportsZip": true.
38 // * "supportsTemplates" indicates whether HTML files should be treated and
39 // renderered as templates, versus just plain text. Complex documentation
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.
44 //"cr-chrome-docs-home": {
46 //"dir": "chrome/docs"
48 //"serveFrom": "home",
49 //"supportsTemplates": true
51 "cr-extensions-examples": {
53 "dir": "chrome/common/extensions/docs/examples"
55 "serveFrom": "extensions/examples",
60 "dir": "chrome/common/extensions/docs/templates/public"
63 "supportsTemplates": true
67 "dir": "chrome/common/extensions/docs/static"
73 "dir": "native_client_sdk/doc_generated"
75 "serveFrom": "native-client",
76 "supportsTemplates": true
79 // GitHub is not working at the moment. Disable entirely.
83 // "owner": "GoogleChrome",
84 // "repo": "devtools-docs-migration"
86 // "serveFrom": "devtools",
87 // "supportsTemplates": true
89 //"multidevice-docs": {
91 // "owner": "GoogleChrome",
92 // "repo": "multi-device"
94 // "serveFrom": "multidevice",
95 // "supportsTemplates": true
99 // "owner": "GoogleChrome",
100 // "repo": "webstore-docs"
102 // "serveFrom": "webstore",
103 // "supportsTemplates": true