Bug 1359997: update docs to point users to the parameters artifact; r?bdahl draft
authorDustin J. Mitchell <dustin@mozilla.com>
Wed, 26 Apr 2017 21:16:16 +0000
changeset 569015 2d8958ba83bd5e0ba672d677895548c518ffa4c9
parent 567579 24cf0be13b7126e3417f121dff0d6b5594aaf1cc
child 626099 6a6ca0897aea74a4f8c9708aad83608c7eb48db7
push id56057
push userdmitchell@mozilla.com
push dateWed, 26 Apr 2017 22:05:13 +0000
reviewersbdahl
bugs1359997
milestone55.0a1
Bug 1359997: update docs to point users to the parameters artifact; r?bdahl MozReview-Commit-ID: KGt3MIniUe6
taskcluster/docs/how-tos.rst
--- a/taskcluster/docs/how-tos.rst
+++ b/taskcluster/docs/how-tos.rst
@@ -26,25 +26,26 @@ more common changes to the task graph wi
     gradual transition, please open a new bug to remind yourself to remove the
     complexity when the transition is complete.
 
 Hacking Task Graphs
 -------------------
 
 The recommended process for changing task graphs is this:
 
-1. Find a recent decision task on the project or branch you are working on,
-   and download its ``parameters.yml`` from the Task Inspector or you can 
-   simply take note of the ``URL`` of the file or the ``task-id``.  This file
-   contains all of the inputs to the task-graph generation process.  Its
-   contents are simple enough if you would like to modify it, and it is
-   documented in :doc:`parameters`.
+1. Find a recent decision task on the project or branch you are working on, and
+   download its ``parameters.yml`` artifact.  Alternately, you
+   can simply take note of the artifact URL, or just the decision task's
+   ``task-id``.  This file contains all of the inputs to the task-graph
+   generation process.  Its contents are simple enough if you would like to
+   modify it, and it is documented in :doc:`parameters`.
 
 2. Run one of the ``mach taskgraph`` subcommands (see :doc:`taskgraph`) to
-   generate a baseline against which to measure your changes.  For example:
+   generate a baseline against which to measure your changes, passing the
+   parameters you found in the previous step.  For example:
 
    .. code-block:: none
 
        ./mach taskgraph tasks --json -p parameters.yml > old-tasks.json
        ./mach taskgraph tasks --json -p url/to/parameters.yml > old-tasks.json
        ./mach taskgraph tasks --json -p task-id=<task-id> > old-tasks.json
 
 3. Make your modifications under ``taskcluster/``.