Closed Bug 1243005 Opened 8 years ago Closed 8 years ago

Write initial documentation for docker

Categories

(Taskcluster :: General, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: armenzg, Assigned: armenzg)

References

Details

I will be composing an initial draft and ask pmoore for feedback.
We will be posting this on MDN.

I assume that in the long term we will have mach help us do things for the developer.
I will be looking into this.
I've put an initial draft for interactive session:
https://developer.mozilla.org/en-US/docs/Running_automated_tests/TaskCluster_interactive_session

The more I think about it, it is easier to run tests through interactive session than running it locally.
pmoore: IIRC you were interested on giving me your feedback once I had the documentation up.

Would you mind having a look at this section and 2 new pages? Everyone else is also welcome.
https://developer.mozilla.org/en-US/docs/Running_automated_tests#Run_tests_against_builds_generated_from_automation_%28aka_Treeherder%29
https://developer.mozilla.org/en-US/docs/Running_automated_tests/TaskCluster_interactive_session
https://developer.mozilla.org/en-US/docs/Running_automated_tests/Docker

I will meanwhile work on bug 1245254 which will improve the docs a bit.
Flags: needinfo?(pmoore)
Switching to jmaher since pmoore seems to be away.
Flags: needinfo?(pmoore) → needinfo?(jmaher)
there is a link to docker which doesn't exist from this page:
https://developer.mozilla.org/en-US/docs/Running_automated_tests/TaskCluster_interactive_session

the link points to:
https://developer.mozilla.org/en-US/docs/Running_automated_tests/Running_automated_tests/Docker

Overall this is a good start on the docs.  It seems very much like a set of notes, instead of a series of steps and docs.

One thing I didn't understand on https://developer.mozilla.org/en-US/docs/Running_automated_tests#Run_tests_against_builds_generated_from_automation_%28aka_Treeherder%29, is that you mention the tc filter, that confused me and I had to read it a few times to grok it.

There are no docs about how to run docker locally.  I could see a brief overview of:
* taskcluster tests vs buildbot tests

then:
* how to run taskcluster tests locally
* how to get a taskcluster loaner (one click)
* debugging tricks on taskcluster
Flags: needinfo?(jmaher)
Thanks Joel for getting to this before me.
I've added information of TaskCluster/Buildbot to this section:
https://developer.mozilla.org/en-US/docs/Running_automated_tests#Run_tests_against_builds_generated_from_automation_(aka_Treeherder)

I fixed the link to Docker. I fixed the comments about the filter.

The documentation for docker will improve after bug 1245254.

Is this good for now?
Flags: needinfo?(jmaher)
I think this is a great start and doesn't leave too much confusion- I know we have a lot of cleanup and polish on the toolchain overall- lets not overdo the docs now!
Flags: needinfo?(jmaher)
Great!
I will close it for now. I will add more info as we fix the toolchain.
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.