summaryrefslogtreecommitdiffstats
path: root/tools/moztreedocs/docs/run-try-job.rst
blob: d7fe6b20b8e4dbb55fdfbccdcd8972be6aceb83d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Running a try job for Documentation
-----------------------------------

Documentation has two try jobs associated:

  - ``doc-generate`` - This generates the documentation with the committed changes on the try server and gives the same output as if it has landed on regular integration branch.

   .. code-block:: shell

      mach try fuzzy -q "'doc-generate"

  - ``doc-upload`` - This uploads documentation to `gecko-l1 bucket <http://gecko-docs.mozilla.org-l1.s3.us-west-2.amazonaws.com/index.html>`__ with the committed changes.

   .. code-block:: shell

      mach try fuzzy -q "'doc-upload"

When the documentation is modified, at review phase, reviewbot will automatically generate a temporary documentation with a direct link to the modified pages.

.. important::

   Running try jobs require the user to have try server access.

.. note::

   To learn more about setting up try server or
   using a different selector head over to :ref:`try server documentation <Pushing to Try>`