diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-19 12:18:15 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-19 12:18:15 +0200 |
| commit | 6394015463f93481e3617d9f29a110d1ceb2ca7f (patch) | |
| tree | 7b331196f747d961c66d7aaa9d09fd7c304a19c9 | |
| parent | 8ad14268c6cb09c82777f7a0e84094c429ad2725 (diff) | |
| download | gitlab-ce-refine-docs-trigger-script-and-use-a-really-long-branch-name-to-test-it.tar.gz | |
Add debugging tips in case something went wrongrefine-docs-trigger-script-and-use-a-really-long-branch-name-to-test-it
| -rw-r--r-- | doc/development/writing_documentation.md | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 6404ecb3423..b1eb020a592 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -128,11 +128,24 @@ preview the changes. The docs URL can be found in two places: - In the output of the `review-docs-deploy` job, which also includes the triggered pipeline so that you can investigate whether something went wrong -CAUTION: **Caution:** -If the branch name slug is longer than 35 characters, it will be -automatically truncated. In that case, the merge request widget will not -show the proper URL due to a limitation of how `environment: url` is defined, -but you can find the real URL from the output of the `review-docs-deploy` job. +In case the Review App URL returns 404, follow these steps to debug: + +1. **Did you follow the URL from the merge request widget?** If yes, then check if + the link is the same as the one in the job output. It can happen that if the + branch name slug is longer than 35 characters, it is automatically + truncated. That means that the merge request widget will not show the proper + URL due to a limitation of how `environment: url` works, but you can find the + real URL from the output of the `review-docs-deploy` job. +1. **Did you follow the URL from the job output?** If yes, then it means that + either the site is not yet deployed or something went wrong with the remote + pipeline. Give it a few minutes and it should appear online, otherwise you + can check the status of the remote pipeline from the link in the job output. + If the pipeline failed or got stuck, drop a line in the `#docs` chat channel. + +TIP: **Tip:** +Someone that has no merge rights to the CE/EE projects (think of forks from +contributors) will not be able to run the manual job. In that case, you can +ask someone from the GitLab team who has the permissions to do that for you. NOTE: **Note:** Make sure that you always delete the branch of the merge request you were |