1599825 - Write more extensive docs for community-tc, link to them from the deployment

Status: NEW

(Taskcluster :: Services, enhancement)

Description

[Dustin J. Mitchell [:dustin] (he/him)]

Docs on things like:

• what sorts of things are supported in this deployment and how it differs from firefox-ci
• our overall approach: projects, externally managed stuff, accepting PRs, etc.
• what is in project "misc" and what is not

Comment 1

[Chris Cooper [:coop] (he/him)]

Miles: are you still working on this?

Comment 2

[Miles Crabill [:miles]]

I can work on this. Where is the best place for these docs to live / be worked on? The scope of the repo readme and docs.taskcluster.net both seem not to include specific deployments of taskcluster.

Comment 3

[Dustin J. Mitchell [:dustin] (he/him)]

That's intentional :)

We just added <SiteSpecific> for this purpose -- https://github.com/taskcluster/taskcluster/pull/2664

So I think the idea here would be to add some documentation to https://github.com/mozilla/community-tc-config/ (maybe just in markdown files) and then add some SiteSpecific links to the TC docs at a few generic points to link to those files. For this bug in particular, that may be a SiteSpecific on https://docs.taskcluster.net/docs/. If there are other logical places to add such a thing, that's great too. Probably a good litmust test is that firefox-ci admins might also want to link from the same place to different docs.