Add note about ephemeral statuses in headings
[ci skip]
This commit is contained in:
parent
168cd3811f
commit
69ab287b36
1 changed files with 3 additions and 1 deletions
|
@ -93,6 +93,8 @@ merge request.
|
||||||
links shift too, which eventually leads to dead links. If you think it is
|
links shift too, which eventually leads to dead links. If you think it is
|
||||||
compelling to add numbers in headings, make sure to at least discuss it with
|
compelling to add numbers in headings, make sure to at least discuss it with
|
||||||
someone in the Merge Request
|
someone in the Merge Request
|
||||||
|
- Avoid adding things that show ephemeral statuses. For example, if a feature is
|
||||||
|
considered beta or experimental, put this info in a note, not in the heading.
|
||||||
- When introducing a new document, be careful for the headings to be
|
- When introducing a new document, be careful for the headings to be
|
||||||
grammatically and syntactically correct. It is advised to mention one or all
|
grammatically and syntactically correct. It is advised to mention one or all
|
||||||
of the following GitLab members for a review: `@axil`, `@rspeicher`, `@marcia`,
|
of the following GitLab members for a review: `@axil`, `@rspeicher`, `@marcia`,
|
||||||
|
@ -466,4 +468,4 @@ curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "domain
|
||||||
[doc-restart]: ../administration/restart_gitlab.md "GitLab restart documentation"
|
[doc-restart]: ../administration/restart_gitlab.md "GitLab restart documentation"
|
||||||
[ce-3349]: https://gitlab.com/gitlab-org/gitlab-ce/issues/3349 "Documentation restructure"
|
[ce-3349]: https://gitlab.com/gitlab-org/gitlab-ce/issues/3349 "Documentation restructure"
|
||||||
[graffle]: https://gitlab.com/gitlab-org/gitlab-design/blob/d8d39f4a87b90fb9ae89ca12dc565347b4900d5e/production/resources/gitlab-map.graffle
|
[graffle]: https://gitlab.com/gitlab-org/gitlab-design/blob/d8d39f4a87b90fb9ae89ca12dc565347b4900d5e/production/resources/gitlab-map.graffle
|
||||||
[gitlab-map]: https://gitlab.com/gitlab-org/gitlab-design/raw/master/production/resources/gitlab-map.png
|
[gitlab-map]: https://gitlab.com/gitlab-org/gitlab-design/raw/master/production/resources/gitlab-map.png
|
||||||
|
|
Loading…
Reference in a new issue