summaryrefslogtreecommitdiff
path: root/doc/development/writing_documentation.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2017-09-07 15:43:20 +0000
committerRémy Coutable <remy@rymai.me>2017-09-07 15:43:20 +0000
commitecdab9f96f5ab94292b52010618847e88e8573fd (patch)
tree9b03335ced51b8682214b7b62d3b986c04fa4455 /doc/development/writing_documentation.md
parent4ae8e20c9c860e5d5d6a148e9f4ee0ae7b8c8946 (diff)
downloadgitlab-ce-ecdab9f96f5ab94292b52010618847e88e8573fd.tar.gz
Add script and job to trigger a docs build
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r--doc/development/writing_documentation.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index eac9ec2a470..479258f743e 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -103,3 +103,24 @@ If that job fails, read the instructions in the job log for what to do next.
Contributors do not need to submit their changes to EE, GitLab Inc. employees
on the other hand need to make sure that their changes apply cleanly to both
CE and EE.
+
+## Previewing the changes live
+
+If you want to preview your changes live, you can use the manual `build-docs`
+job in your merge request.
+
+![Manual trigger a docs build](img/manual_build_docs.png)
+
+This job will:
+
+1. Create a new branch in the [gitlab-docs](https://gitlab.com/gitlab-com/gitlab-docs)
+ project named after the scheme: `<CE/EE-branch-slug>-built-from-ce-ee`
+1. Trigger a pipeline and build the docs site with your changes
+
+Look for the docs URL at the output of the `build-docs` job.
+
+>**Note:**
+Make sure that you always delete the branch of the merge request you were
+working on. If you don't, the remote docs branch won't be removed either,
+and the server where the Review Apps are hosted will eventually be out of
+disk space.