diff options
author | Filipa Lacerda <filipa@gitlab.com> | 2017-05-19 16:20:48 +0100 |
---|---|---|
committer | Filipa Lacerda <filipa@gitlab.com> | 2017-05-19 16:20:48 +0100 |
commit | 4d9ad9f93c5818a181e4feba47f97212327ac087 (patch) | |
tree | 9b0d7fb8f053b89c41417f0c21aca42cd478dc41 /doc/development/writing_documentation.md | |
parent | 4d8f98693726b54d0e1c384a641e9aa6627fdf41 (diff) | |
parent | 60d5063d15fd43f89d5b4ebf379d7a64768a0953 (diff) | |
download | gitlab-ce-24339-job-page.tar.gz |
Merge branch 'master' into 24339-job-page24339-job-page
* master: (190 commits)
Replaced duplicate z-index with index of 400
Enable RSpec profiling only if RSPEC_PROFILING_POSTGRES_URL is not empty
Add descriptions for the RSpec/EmptyExampleGroup and RSpec/ExpectOutput cops
Add note about artifacts previewing in docs
MRWidget: Make error message bold and red.
Fixes the 500 for custom apearance header logo and logo
MRWidget: Change refresh button place in failed state.
Remove readme project_view option
Update prometheus documentation
Fix JavaScript translations that are using a namespace
MRWidget: Add refresh button into MR widget failed state.
Add s selectors for supported avatars.
Render plain README using Markup viewer so it is displayed below tree
Add docs on how to turn off SSL verification on GH oauth
Fix clicking disabled clipboard button toolip
Stop MR conflict code from blowing up when branches are missing
Update edit.html.haml Closes #32555
Fixes per feedback on user avatar components.
Consolidate user avatar Vue logic
Fixes for the rename reserved paths helpers
...
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r-- | doc/development/writing_documentation.md | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 657a826d7ee..eac9ec2a470 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -78,14 +78,21 @@ Currently GitLab docs use Redcarpet as [markdown](../user/markdown.md) engine, b We try to treat documentation as code, thus have implemented some testing. Currently, the following tests are in place: -1. `docs:check:links`: Check that all internal (relative) links work correctly -1. `docs:check:apilint`: Check that the API docs follow some conventions +1. `docs lint`: Check that all internal (relative) links work correctly and + that all cURL examples in API docs use the full switches. If your contribution contains **only** documentation changes, you can speed up -the CI process by prepending to the name of your branch: `docs/`. For example, -a valid name would be `docs/update-api-issues` and it will run only the docs -tests. If the name is `docs-update-api-issues`, the whole test suite will run -(including docs). +the CI process by following some branch naming conventions. You have three +choices: + +| Branch name | Valid example | +| ----------- | ------------- | +| Starting with `docs/` | `docs/update-api-issues` | +| Starting with `docs-` | `docs-update-api-issues` | +| Ending in `-docs` | `123-update-api-issues-docs` | + +If your branch name matches any of the above, it will run only the docs +tests. If it doesn't, the whole test suite will run (including docs). --- |