Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
hpc-compendium
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ZIH
hpcsupport
hpc-compendium
Commits
71876b03
Commit
71876b03
authored
2 years ago
by
Jan Frenzel
Committed by
Taras Lazariv
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Apply 1 suggestion(s) to 1 file(s)
parent
0ae98fd8
No related branches found
No related tags found
2 merge requests
!592
Automated merge from preview to main
,
!554
Content rules
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+3
-1
3 additions, 1 deletion
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
with
3 additions
and
1 deletion
doc.zih.tu-dresden.de/docs/contrib/content_rules.md
+
3
−
1
View file @
71876b03
...
...
@@ -95,7 +95,9 @@ nav:
Follow these two steps to
**add a new page**
to the documentation:
1.
Create a new Markdown file under
`docs/subdir/file_name.md`
and put the documentation inside.
The sub-directory and file name should follow the pattern
`fancy_title_and_more.md`
.
The sub-directory structure represents different topics of the documentation. Try to fit the
contribution into the existing structure. The file name should reflect the title of the
documentation page, i. e.
`shortened_page_heading.md`
.
1.
Add
`subdir/file_name.md`
to the configuration file
`mkdocs.yml`
by updating the navigation
section. Yes, the order of files is crucial and defines the structure of the content. Thus,
carefully consider the right spot and section for the new page.
...
...
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