summaryrefslogtreecommitdiffstats
path: root/tools/moztreedocs/docs/run-try-job.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:22:09 +0000
commit43a97878ce14b72f0981164f87f2e35e14151312 (patch)
tree620249daf56c0258faa40cbdcf9cfba06de2a846 /tools/moztreedocs/docs/run-try-job.rst
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 110.0.1.upstream/110.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--tools/moztreedocs/docs/run-try-job.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/tools/moztreedocs/docs/run-try-job.rst b/tools/moztreedocs/docs/run-try-job.rst
new file mode 100644
index 0000000000..d7fe6b20b8
--- /dev/null
+++ b/tools/moztreedocs/docs/run-try-job.rst
@@ -0,0 +1,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>`