Taskcluster Documentation Site
This is the Taskcluster documentation site, hosted at
/docs within a Taskcluster deployment.
It's a basic static site, generated with some Gulp plugins.
user-config.ymland fill in the blanks. Note: This config is only used during development!
- [Optional] If you want remote references locally, run
npm run downloador
- Run the webserver:
yarn start. * Note that it does not auto-reload on change.
This site is deployed using Nginx, serving static content. Build the static
gulp build-static, or if you want to run the webserver right
Note that we still support the "old way" as well, so much of the site is designed around producing objects to upload to S3, and then reverse-engineered into static files for Nginx.
Publishing (Old Way)
This is done automatically, but for the record:
npm run deploy or
Third-Party Libraries and Tools
The Taskcluster Documentation Site wouldn't have been so awesome without these amazing libraries and tools, upon which it is built.
ejs_production.jsfrom EJS is licensed under the MIT License,
jquery.min.jsfrom jQuery is licensed under the MIT license,
marked.jsfrom marked is licensed under the MIT license,
raphael-min.jsfrom Raphael is licensed under the MIT license.
sequence-diagram-min.jsfrom [JS Sequence Diagrams] (https://github.com/bramp/js-sequence-diagrams) is licensed under the Simplified BSD License.
superagent-promise.jsis a browserify bundle of superagent, superagent-promise and promise all licensed under MIT.
- Files in
bootstrap/from Bootstrap is licensed under the MIT license.
- Files in
bootstrap-select/from [bootstrap-select] (https://github.com/silviomoreto/bootstrap-select) is licensed under the MIT license.
promise.jsis from [es6-promises by Jake Archibald] (https://github.com/jakearchibald/es6-promise) is licensed under the MIT license.