Hexcles/taskcluster-docs

Documentation for taskcluster components

TaskCluster Documentation Site

This is the taskcluster documentation site, hosted at https://docs.taskcluster.net. It's a basic static site, generated with some Gulp plugins.

Development Setup

1. Copy user-config-example.yml into user-config.yml and fill in the blannks. Note: This config is only used during development!
2. Install: npm install
3. [Optional] If you want remote references locally, run gulp download.
4. Run the webserver: gulp webserver * Note that it does not auto-reload on change.

Publishing

This is done automatically, but for the record:

gulp publish

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.

Libraries,

• d3.v3.min.js from d3js licensed under the BSD License,
• dagre-d3.min.js from dagre-d3 licensed under the MIT License,
• ejs_production.js from EJS is licensed under the MIT License,
• highlight.css from Pygments is licensed under the BSD license,
• jquery.min.js from jQuery is licensed under the MIT license,
• jsonform.js from JSONForm is licensed under the MIT license,
• marked.js from marked is licensed under the MIT license,
• moment.min.js from momentjs is licensed under the MIT license,
• prism.js and prism.css from PRISM is licensed under the MIT license.
• raphael-min.js from Raphael is licensed under the MIT license.
• sequence-diagram-min.js from [JS Sequence Diagrams] (https://github.com/bramp/js-sequence-diagrams) is licensed under the Simplified BSD License.
• superagent-promise.js is a browserify bundle of superagent, superagent-promise and promise all licensed under MIT.
• term.js from term.js is licensed under the MIT license.
• underscore-min.js from underscore.js is licensed under the MIT license.
• Files in ace/ are from Ace is licensed under the BSD license.
• 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.
• Files in docson/ from Docson is licensed under the Apache License, Version 2.
• Files in JSONFormatter/ by [Redsandro and Vladimir Bodurov] (https://gist.github.com/Redsandro/5473335) is licensed under the MIT license.
• promise.js is from [es6-promises by Jake Archibald] (https://github.com/jakearchibald/es6-promise) is licensed under the MIT license.