Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
4499d24a
Commit
4499d24a
authored
Oct 16, 2019
by
Ben Prescott
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs style guide: expand,clarify links section
parent
7f98a4ae
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
40 additions
and
9 deletions
+40
-9
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+40
-9
No files found.
doc/development/documentation/styleguide.md
View file @
4499d24a
...
@@ -492,19 +492,50 @@ For other punctuation rules, please refer to the
...
@@ -492,19 +492,50 @@ For other punctuation rules, please refer to the
-
Use inline link markdown markup
`[Text](https://example.com)`
.
-
Use inline link markdown markup
`[Text](https://example.com)`
.
It's easier to read, review, and maintain.
**Do not**
use
`[Text][identifier]`
.
It's easier to read, review, and maintain.
**Do not**
use
`[Text][identifier]`
.
-
To link to internal documentation, use relative links, not full URLs. Use
`../`
to
navigate to high-level directories, and always add the file name
`file.md`
at the
end of the link with the
`.md`
extension, not
`.html`
.
Example: instead of
`[text](../../merge_requests/)`
, use
`[text](../../merge_requests/index.md)`
or,
`[text](../../ci/README.md)`
, or,
for anchor links,
`[text](../../ci/README.md#examples)`
.
Using the markdown extension is necessary for the
[
`/help`
](
index.md#gitlab-help
)
section of GitLab.
-
To link from CE to EE-only documentation, use the EE-only doc full URL.
-
Use
[
meaningful anchor texts
](
https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/
)
.
-
Use
[
meaningful anchor texts
](
https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/
)
.
E.g., instead of writing something like
`Read more about GitLab Issue Boards [here](LINK)`
,
E.g., instead of writing something like
`Read more about GitLab Issue Boards [here](LINK)`
,
write
`Read more about [GitLab Issue Boards](LINK)`
.
write
`Read more about [GitLab Issue Boards](LINK)`
.
### Links to internal documentation
-
To link to internal documentation, use relative links, not full URLs.
Use
`../`
to navigate to high-level directories. Links should not refer to root.
Don't:
```
md
[
Geo Troubleshooting
](
https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html
)
[
Geo Troubleshooting
](
/ee/administration/geo/replication/troubleshooting.md
)
```
Do:
```
md
[
Geo Troubleshooting
](
../../geo/replication/troubleshooting.md
)
```
-
Always add the file name
`file.md`
at the end of the link with the
`.md`
extension, not
`.html`
.
Don't:
```
md
[
merge requests
](
../../merge_requests/
)
[
issues
](
../../issues/tags.html
)
[
issue tags
](
../../issues/tags.html#stages
)
```
Do:
```
md
[
merge requests
](
../../merge_requests/index.md
)
[
issues
](
../../issues/tags.md
)
[
issue tags
](
../../issues/tags.md#stages
)
```
-
Using the markdown extension is necessary for the
[
`/help`
](
index.md#gitlab-help
)
section of GitLab.
### Links requiring permissions
### Links requiring permissions
Don't link directly to:
Don't link directly to:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment