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
227dac7f
Commit
227dac7f
authored
Mar 15, 2020
by
Ben Prescott
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Make it easier to find links documentation
parent
872f0550
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
3 deletions
+4
-3
doc/development/documentation/index.md
doc/development/documentation/index.md
+4
-3
No files found.
doc/development/documentation/index.md
View file @
227dac7f
...
...
@@ -8,7 +8,7 @@ GitLab's documentation is [intended as the single source of truth (SSOT)](https:
In addition to this page, the following resources can help you craft and contribute documentation:
-
[
Style Guide
](
styleguide.md
)
- What belongs in the docs, language guidelines, Markdown standards to follow, and more.
-
[
Style Guide
](
styleguide.md
)
- What belongs in the docs, language guidelines, Markdown standards to follow,
links,
and more.
-
[
Structure and template
](
structure.md
)
- Learn the typical parts of a doc page and how to write each one.
-
[
Documentation process
](
workflow.md
)
.
-
[
Markdown Guide
](
../../user/markdown.md
)
- A reference for all Markdown syntax supported by GitLab.
...
...
@@ -116,8 +116,9 @@ Things to note:
-
The above
`git grep`
command will search recursively in the directory you run
it in for
`workflow/lfs/lfs_administration`
and
`lfs/lfs_administration`
and will print the file and the line where this file is mentioned.
You may ask why the two greps. Since we use relative paths to link to
documentation, sometimes it might be useful to search a path deeper.
You may ask why the two greps. Since
[
we use relative paths to link to
documentation
](
styleguide.md#links
)
, sometimes it might be useful to search a path deeper.
-
The
`*.md`
extension is not used when a document is linked to GitLab's
built-in help page, that's why we omit it in
`git grep`
.
-
Use the checklist on the "Change documentation location" MR description template.
...
...
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