Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vincent Sellier
swh-docs
Commits
42976e4f
Verified
Commit
42976e4f
authored
3 years ago
by
Antoine R. Dumont
Browse files
Options
Downloads
Patches
Plain Diff
contributing-docs: Fix links rendering and typos
Related to T3648
parent
67977961
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/contributing/tutorial-docs-contribution.rst
+6
-7
6 additions, 7 deletions
docs/contributing/tutorial-docs-contribution.rst
with
6 additions
and
7 deletions
docs/contributing/tutorial-docs-contribution.rst
+
6
−
7
View file @
42976e4f
...
...
@@ -84,13 +84,12 @@ We are following Divio's approach with four major types of documentation:
* Reference: theoretical/technical knowledge which is information oriented.
* Explanation: theoretical knowledge
which is
understanding
oriented to analyze, discuss
and
explain different decisions, including background and context.
* Explanation: theoretical knowledge understanding
-
oriented to analyze, discuss
and
explain different decisions, including background and context.
For more information:
https://documentation.divio.com/
And Daniele Procida presentation on:
https://www.youtube.com/watch?v=t4vKPhjcMZg
For more information see `the divio documentation <https://documentation.divio.com/>`_
and/or `Daniele Procida's presentation <https://www.youtube.com/watch?v=t4vKPhjcMZg>`_
.. note::
We propose using in the following naming scheme depending on the type of document:
...
...
@@ -103,7 +102,7 @@ https://www.youtube.com/watch?v=t4vKPhjcMZg
Step 4: Create a page or sub-section with multiple pages
--------------------------------------------------------
#. Create a *.rst* file with a short name of your doc in the approriate directory (see
#. Create a *.rst* file with a short name of your doc in the appro
p
riate directory (see
step 2). If this is a sub-section, the first file should be an *index.rst* file
containing the list of the current sub-section files.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment