diff options
author | Rémy Coutable <remy@rymai.me> | 2017-12-05 14:25:07 +0300 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2017-12-05 14:25:07 +0300 |
commit | e25b2df8a2a9186bf2eaa5b9b217bbcdbfcbf972 (patch) | |
tree | 20f13ab6b9df9b8cfd3a8a09546943700a3376e7 | |
parent | 4ca4b0ff702a68a9aed5da70d9170da410eefafa (diff) | |
parent | 07e42c5c425b5a781398fea2aaf7eeb8a825724f (diff) |
Merge branch 'docs/clarify-review-docs-process' into 'master'
Clarify the docs review process and mention the supported repos
See merge request gitlab-org/gitlab-ce!15573
-rw-r--r-- | doc/development/writing_documentation.md | 13 |
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: |