Bug 1381622: order the actions docs more naturally; r=jonasfj
authorDustin J. Mitchell <dustin@mozilla.com>
Mon, 17 Jul 2017 19:28:58 +0000
changeset 369491 ce23a45500a547c594931dbfc9f77cf01c19e299
parent 369490 050b7291d367d0e1443e9c8d4f56e00d2f3b874a
child 369492 f639c0a09d0f4888598ee5c6b7f0c42ae1cd5971
push id32198
push userryanvm@gmail.com
push dateWed, 19 Jul 2017 13:22:22 +0000
treeherdermozilla-central@a1ea69a3a0a7 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjonasfj
bugs1381622
milestone56.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1381622: order the actions docs more naturally; r=jonasfj MozReview-Commit-ID: GaMlrhkEdnk
taskcluster/docs/action-details.rst
taskcluster/docs/action-implementation.rst
taskcluster/docs/actions.rst
rename from taskcluster/docs/action-details.rst
rename to taskcluster/docs/action-implementation.rst
--- a/taskcluster/docs/actions.rst
+++ b/taskcluster/docs/actions.rst
@@ -1,28 +1,27 @@
 Actions
 =======
 
 This section shows how to define an action in-tree such that it shows up in
 supported user interfaces like Treeherder.
 
 At a very high level, the process looks like this:
 
- * The decision task produces an artifact indicating what actions are
-   available.
+ * The decision task produces an artifact, ``public/actions.json``, indicating
+   what actions are available.
 
- * The user interface consults that artifact and presents appropriate choices
-   to the user, possibly involving gathering additional data from the user,
-   such as the number of times to re-trigger a test case.
+ * A user interface (for example, Treeherder or the Taskcluster tools) consults
+   ``actions.json`` and presents appropriate choices to the user, if necessary
+   gathering additional data from the user, such as the number of times to
+   re-trigger a test case.
 
  * The user interface follows the action description to carry out the action.
    In most cases (``action.kind == 'task'``), that entails creating an "action
    task", including the provided information. That action task is responsible
    for carrying out the named action, and may create new sub-tasks if necessary
    (for example, to re-trigger a task).
 
-For details on interface between in-tree logic and external user interfaces,
-see :doc:`the specification for actions.json <action-spec>`.
 
 .. toctree::
 
-    action-details
     action-spec
+    action-implementation