Oh, did I mention: F) In order to get nice urls like docs.taskcluster.net/queue/api-docs/ we have a folder called api-docs/ and a file called index.html. Basically all of the HTML and markdown files are called index.html or index.md Needless to say that all files being separate folder and being called index.(html|md) is very horrible. And make it hard to find the right file when editing the documentation. We can do smarter than this.
When doing this we should probably consider moving all tools from the docs site into: tools.taskcluster.net Note, looking at various things we used... some grunt setup is probably the way to go.
James and I had a discussion in another bug that it would be nice if docs were located in the repository they documented, and uploaded when we deployed the code. Like how references for apis and exchanges are done. I wrote a proposal here: https://etherpad.mozilla.org/jonasfj-taskcluster-documentation-rethink We should discuss that... I think making an API for references.taskcluster.net is near trivial, like half a days work. Setting up S3 + cloudfront for SSL should be easy too (I have the certificates). Only complicated thing is generating documentation from JSON files stored on references.taskcluster.net. But that's already complicated :)
the other related by I was mentioning is bug 1070756.
Note, tools.taskcluster.net have been created and we have started to move tools to it. So hopefully we'll soon have removed all our tools from docs.taskcluster.net
Component: TaskCluster → General
Product: Testing → Taskcluster
just a note that we might want to query the provisioner to possibly generate docs for worker types.
Component: General → Documentation
I fixed most of the "horrible things" above. I kinda hate Jekyll, but it is nice that Github generates and hosts the docs for us. I don't think it'd be much harder to use a Node-based templating system that generates a site and use some command-line tool to upload that to an S3 bucket, then host the site on S3. That would get us a bit more flexibility and remove the Ruby requirement. But maybe not today. The one thing I'd like to do here is to move the directories in the repo around to better match the menu structure.
Assignee: nobody → dustin
Let's move that last bit to bug 1257945
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.