summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2017-11-23 13:17:10 +0100
committerAchilleas Pipinellis <axil@gitlab.com>2017-11-23 13:17:10 +0100
commit07e42c5c425b5a781398fea2aaf7eeb8a825724f (patch)
treeff813c73e20ce3db98e647089b225e35b0fa520a
parent904a625edd743ea4707598d0e285b6a8607e95d5 (diff)
downloadgitlab-ce-docs/clarify-review-docs-process.tar.gz
Clarify the docs review process and mention the supported reposdocs/clarify-review-docs-process
-rw-r--r--doc/development/writing_documentation.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index 68ba3dd2da3..b6def7ef541 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -152,12 +152,23 @@ CE and EE.
## Previewing the changes live
If you want to preview the doc changes of your merge request live, you can use
-the manual `review-docs-deploy` job in your merge request.
+the manual `review-docs-deploy` job in your merge request. You will need at
+least Master permissions to be able to run it and is currently enabled for the
+following projects:
+
+- https://gitlab.com/gitlab-org/gitlab-ce
+- https://gitlab.com/gitlab-org/gitlab-ee
+
+NOTE: **Note:**
+You will need to push a branch to those repositories, it doesn't work for forks.
TIP: **Tip:**
If your branch contains only documentation changes, you can use
[special branch names](#testing) to avoid long running pipelines.
+In the mini pipeline graph, you should see an `>>` icon. Clicking on it will
+reveal the `review-docs-deploy` job. Hit the play button for the job to start.
+
![Manual trigger a docs build](img/manual_build_docs.png)
This job will: