@@ -974,7 +974,7 @@ sure to replace it with the new one.
Important:
- Avoid crosslinking documentation to headings unless you need to link to a
specific section of the document. This will avoid breaking anchors in the
specific section of the document. This avoids breaking anchors in the
future in case the heading is changed.
- If possible, avoid changing headings since they're not only linked internally.
There are various links to GitLab documentation on the internet, such as
...
...
@@ -1023,7 +1023,7 @@ documentation in separate projects (for example, linking to Omnibus documentatio
from GitLab documentation), you must use absolute URLs.
Do not use absolute URLs like `https://docs.gitlab.com/ee/index.html` to
crosslink to other documentation within the same project. Use relative links to
cross-link to other documentation within the same project. Use relative links to
the file, like `../index.md`. (These are converted to HTML when the site is
rendered.)
...
...
@@ -1052,7 +1052,7 @@ To link to internal documentation:
Do: `../../geo/replication/troubleshooting.md`
- Always add the filename `file.md` at the end of the link with the `.md`
- Always add the filename `file.md` at the end of the link with the `.md`
extension, not `.html`.
Don't:
...
...
@@ -1121,7 +1121,7 @@ Don't link directly to:
- Project features that require [special permissions](../../../user/permissions.md)
to view.
These will fail for:
These fail for:
- Those without sufficient permissions.
- Automated link checkers.
...
...
@@ -1205,9 +1205,9 @@ When you take screenshots:
### Save the image
- Save the image with a lowercase filename that's descriptive of the feature
- Save the image with a lowercase filename that's descriptive of the feature
or concept in the image. If the image is of the GitLab interface, append the
GitLab version to the filename, based on the following format:
GitLab version to the filename, based on the following format:
`image_name_vX_Y.png`. For example, for a screenshot taken from the pipelines
page of GitLab 11.1, a valid name is `pipelines_v11_1.png`. If you're adding an
illustration that doesn't include parts of the user interface, add the release
...
...
@@ -1217,10 +1217,10 @@ When you take screenshots:
the `.md` document that you're working on is located.
- Consider using PNG images instead of JPEG.
-[Compress all PNG images](#compress-images).
- Compress gifs with <https://ezgif.com/optimize> or similar tool.
- Compress GIFs with <https://ezgif.com/optimize> or similar tool.
- Images should be used (only when necessary) to _illustrate_ the description
of a process, not to _replace_ it.
- Max image size: 100KB (gifs included).
- Max image size: 100KB (GIFs included).
- See also how to link and embed [videos](#videos) to illustrate the
documentation.
...
...
@@ -1360,7 +1360,7 @@ hidden on the documentation site, but is displayed by `/help`.
and leave a blank line between the command and the output.
- When providing a command without output, don't prefix the shell command with `$`.
- If you need to include triple backticks inside a code block, use four backticks
for the codeblock fences instead of three.
for the codeblock fences instead of three.
- For regular fenced code blocks, always use a highlighting class corresponding to
the language for better readability. Examples:
...
...
@@ -1397,7 +1397,7 @@ of available language classes:
| `graphql` | |
| `haml` | |
| `html` | |
| `ini` | For some simple config files that are not in TOML format. |
| `ini` | For some simple configuration files that are not in TOML format. |
| `javascript` | Alias `js`. |
| `json` | |
| `markdown` | Alias: `md`. |
...
...
@@ -1405,7 +1405,7 @@ of available language classes:
| `nginx` | |
| `perl` | |
| `php` | |
| `plaintext` | Examples with no defined language, such as output from shell commands or API calls. If a codeblock has no language, it defaults to `plaintext`. Alias: `text`. |
| `plaintext` | Examples with no defined language, such as output from shell commands or API calls. If a code block has no language, it defaults to `plaintext`. Alias: `text`.|
