diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-10-27 09:39:56 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-10-27 09:39:56 +0200 |
| commit | 8186e02a8f2aa1c5c6289a59abdea8a5905990ce (patch) | |
| tree | 98ce63674058e29bf9802b5cdac69f5a60d6f53f | |
| parent | 7abcb29d161651418b8ee9041712c31c9d0add06 (diff) | |
| download | gitlab-ce-docs/styleguide-note-on-changing-headings.tar.gz | |
Add a note about changing headings in doc styleguidedocs/styleguide-note-on-changing-headings
[ci skip]
| -rw-r--r-- | doc/development/doc_styleguide.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 2cfa30f652e..725468f0627 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -102,6 +102,10 @@ merge request. live without an audit, thus preventing dead links and redirection issues when corrected - Leave exactly one newline after a heading +- Generally, avoid removing headings that are no longer relevant to the + documentation in order to preserve links. If a change makes more sense than + carrying a wrong heading in the documentation forever, discuss the change with + the tech writing team and apply it. ## Links |