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
2b6d8a40
Commit
2b6d8a40
authored
Aug 17, 2021
by
Russell Dickenson
Committed by
Suzanne Selhorn
Aug 17, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix markdown issue in style guide content
parent
b9f9dd47
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
6 deletions
+8
-6
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+8
-6
No files found.
doc/development/documentation/styleguide/index.md
View file @
2b6d8a40
...
...
@@ -841,9 +841,9 @@ We include guidance for links in these categories:
-
Use inline link Markdown markup
`[Text](https://example.com)`
.
It's easier to read, review, and maintain. Do not use
`[Text][identifier]`
reference-style links.
-
Use
[
meaningful anchor text
s
](
https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/
)
.
For example, instead of writing something like
`Read more about
GitLab Issue Board
s [here](LINK)`
,
write
`Read more about [
GitLab Issue Board
s](LINK)`
.
-
Use
[
meaningful anchor text
](
https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/
)
.
For example, instead of writing something like
`Read more about
merge request
s [here](LINK)`
,
write
`Read more about [
merge request
s](LINK)`
.
### Links to internal documentation
...
...
@@ -1601,9 +1601,11 @@ Do not promise to deliver features in a future release. For example, avoid phras
"Support for this feature is planned."
We cannot guarantee future feature work, and promises
like these can raise legal issues. Instead, say that an issue exists, for example,
"Support for this feature is tracked [in this issue]." Or, "Improvements to
this functionality are tracked [in this issue]."
like these can raise legal issues. Instead, say that an issue exists.
For example:
-
Support for improvements is tracked
`[in this issue](LINK)`
.
-
You cannot do this thing, but
`[an issue exists](LINK)`
to change this behavior.
You can say that we plan to remove a feature.
...
...
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