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; currently the only | 12 // * An object describing where the content originates, either "chromium" |
13 // supported location is "chromium" with a key "dir" specifying which | 13 // or "github". |
14 // chromium directory to look in, e.g. "extensions/samples". | 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. |
15 // | 19 // |
16 // In this example, when the user navigates to | 20 // In the chromium example, when the user navigates to |
17 // | 21 // |
18 // developer.chrome.com/extensions/examples/some/sample/path | 22 // developer.chrome.com/extensions/examples/some/sample/path |
19 // | 23 // |
20 // then | 24 // then |
21 // 1. The "cr-extensions-examples" rule is invoked (since it's served from | 25 // 1. The "cr-extensions-examples" rule is invoked (since it's served from |
22 // "extensions/examples"). | 26 // "extensions/examples"). |
23 // 2. The docserver will look up the path "docs/examples/some/sample/path" | 27 // 2. The docserver will look up the path "docs/examples/some/sample/path" |
24 // in chromium - the URL after the "serveFrom" path (some/sample/path) | 28 // in chromium - the URL after the "serveFrom" path (some/sample/path) |
25 // prefixed by the chromium directory (docs/examples). | 29 // prefixed by the chromium directory (docs/examples). |
26 // 3. Then render and serve it. | 30 // 3. Then render and serve it. |
(...skipping 24 matching lines...) Expand all Loading... |
51 "serveFrom": "", | 55 "serveFrom": "", |
52 "supportsTemplates": true | 56 "supportsTemplates": true |
53 }, | 57 }, |
54 "cr-static": { | 58 "cr-static": { |
55 "chromium": { | 59 "chromium": { |
56 "dir": "docs/static" | 60 "dir": "docs/static" |
57 }, | 61 }, |
58 "serveFrom": "static" | 62 "serveFrom": "static" |
59 } | 63 } |
60 } | 64 } |
OLD | NEW |