1243005 - Write initial documentation for docker

Status: RESOLVED FIXED

(Taskcluster :: General, defect)

Description

[Armen [:armenzg]]

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.

Comment 1

[Armen [:armenzg]]

I will be looking into this.

Comment 2

[Armen [:armenzg]]

Initial placeholder:
https://developer.mozilla.org/en-US/docs/Running_automated_tests#Run_tests_against_builds_generated_from_automation_%28aka_Treeherder%29

Comment 3

[Armen [:armenzg]]

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.

Comment 4

[Armen [:armenzg]]

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.

Comment 5

[Armen [:armenzg]]

Switching to jmaher since pmoore seems to be away.

Comment 6

[Joel Maher ( :jmaher ) (UTC -8)]

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

Comment 7

[Pete Moore [:pmoore][:pete]]

Thanks Joel for getting to this before me.

Comment 8

[Armen [:armenzg]]

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?

Comment 9

[Joel Maher ( :jmaher ) (UTC -8)]

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!

Comment 10

[Armen [:armenzg]]

Great!
I will close it for now. I will add more info as we fix the toolchain.