Bug 1373326 - Flesh out docs a bit. r=dustin draft
authorJustin Wood <Callek@gmail.com>
Thu, 15 Jun 2017 13:47:22 -0400
changeset 597682 d380d4975f8480b65d44c07c099ef6f166228e01
parent 594702 035c25bef7b5e4175006e63eff10c61c2eef73f1
child 597683 a575562ba62e276ccc15f59292f3070e203bc73c
push id64993
push userCallek@gmail.com
push dateTue, 20 Jun 2017 20:14:15 +0000
reviewersdustin
bugs1373326
milestone56.0a1
Bug 1373326 - Flesh out docs a bit. r=dustin (For Landing more OSX Nightly Support from date to central) MozReview-Commit-ID: 2zOkiBS294y
taskcluster/docs/kinds.rst
--- a/taskcluster/docs/kinds.rst
+++ b/taskcluster/docs/kinds.rst
@@ -1,23 +1,27 @@
 Task Kinds
 ==========
 
 This section lists and documents the available task kinds.
 
 build
-------
+-----
 
 Builds are tasks that produce an installer or other output that can be run by
 users or automated tests.  This is more restrictive than most definitions of
 "build" in a Mozilla context: it does not include tasks that run build-like
 actions for static analysis or to produce instrumented artifacts.
 
 build-signing
---------------
+-------------
+
+Many builds must be signed. The build-signing task takes the unsigned `build`
+kind artifacts and passess them through signingscriptworker to a signing server
+and returns signed results.
 
 
 artifact-build
 --------------
 
 This kind performs an artifact build: one based on precompiled binaries
 discovered via the TaskCluster index.  This task verifies that such builds
 continue to work correctly.
@@ -46,17 +50,17 @@ nightly-l10n-signing
 --------------------
 
 The nightly l10n signing kind takes artifacts from the nightly-l10n kind and
 passes them to signing servers to have their contents signed appropriately, based
 on an appropriate signing format. One signing job is created for each nightly-l10n
 job (usually chunked).
 
 source-test
-------------
+-----------
 
 Source-tests are tasks that run directly from the Gecko source. This can include linting,
 unit tests, source-code analysis, or measurement work. While source-test tasks run from
 a source checkout, it is still possible for them to depend on a build artifact, though
 often they do not.
 
 upload-symbols
 --------------
@@ -148,17 +152,17 @@ Docker images are built from subdirector
 depend on another in-tree docker image, without uploading the latter to a
 Docker repository
 
 The task definition used to create the image-building tasks is given in
 ``image.yml`` in the kind directory, and is interpreted as a :doc:`YAML
 Template <yaml-templates>`.
 
 android-stuff
---------------
+-------------
 
 balrog
 ------
 
 Balrog is the Mozilla Update Server. Jobs of this kind are submitting information
 which assists in telling Firefox that an update is available for the related job.
 
 balrog-l10n
@@ -180,25 +184,24 @@ beetmover-l10n
 
 Beetmover L10n, takes specific artifacts, "Beets", and pushes them to a location outside
 of Taskcluster's task artifacts, (archive.mozilla.org as one place) and in the
 process determines the final location and a "pretty" name (versioned product name)
 This separate kind uses logic specific to localized artifacts, such as including
 the language in the final artifact names.
 
 beetmover-repackage
----------
+-------------------
 
 Beetmover-repackage is beetmover but for tasks that need an intermediate step
 between signing and packaging, such as OSX. For more details see the definitions
 of the Beetmover kind above and the repackage kind below.
 
-
 checksums-signing
-----------------
+-----------------
 Checksums-signing take as input the checksums file generated by beetmover tasks
 and sign it via the signing scriptworkers. Returns the same file signed and
 additional detached signature.
 
 beetmover-checksums
 -------------------
 Beetmover, takes specific artifact checksums and pushes it to a location outside
 of Taskcluster's task artifacts (archive.mozilla.org as one place) and in the