Skip to content

Instantly share code, notes, and snippets.

@djmitche
Last active May 16, 2016 17:26
Show Gist options
  • Select an option

  • Save djmitche/784b1b0e8d7220b4389f to your computer and use it in GitHub Desktop.

Select an option

Save djmitche/784b1b0e8d7220b4389f to your computer and use it in GitHub Desktop.
Bug 1257945

To Do:

General

  • reorganize per audience / type
  • SSL / static hosting
  • generate with JS
  • Update the "home page" to give newcomers a better direction to go
  • Improve the consistency of where types of information are available, so we're not left saying "that's somewhere on teh docs site" and not being able to find it (which happens to me all the time)
  • Think carefully about audiences and sub-audiences, and providing just the information required (users (gecko, github, gaia), api consumers, developers)
  • strip task-inspector stuff & dependencies
  • build more dynamic, collapsable TOC menus
  • site accessibility
  • site responsiveness
  • generate bundle.js via gulp (?? it's slow and browserify sucks)

Reference

  • Ensure all services are listed (even with stubs)
  • Check headings on API docs (some have headings/intro in markdown file, some don't)
  • services:
    • login
    • cloud-mirror
    • cors-proxy
    • statsum
    • events
  • more docs for tc-secrets
  • add a page containing just the task definition schema under queue (for easy linking)

Tutorials

  • Merge TC-101/102 into tutorial
    • developer workflow
    • intree-config
    • intree-image
    • tc-github
    • hooks
    • secrets
    • provisioner
    • clients??
  • maja's blog post

Manual

  • detailed documentation of client usage (instead of in clients' README, or in addition?)

  • document how roles work

  • developer guides

    • shrinkwrap
    • running tests
    • loader, config, other tc-lib-* stuff
  • Merge TC-201 into manual

    • Design slides -> devel
    • Use auth diagrams for authentication in manual
    • worker-types into worker-types intro
    • artifact uploads/downloads in queue manual
    • live logging in docker worker
    • interacive sessions in docker worker
@petemoore
Copy link

This is great stuff Dustin. I also wonder how we could more tightly integrate docs with tools site. Do you have thoughts on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment