diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-04-24 21:17:30 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-04-24 21:17:30 +0300 |
commit | 0bf82aa5cb3b1ed826dd5c0d46331e17aa60d9e9 (patch) | |
tree | ee5a760877cce0189cc8e765a912a06942f3e4de /doc/development/documentation/topic_types | |
parent | efbf661c4224d481c57d0346e26983a805e5ec93 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/topic_types')
-rw-r--r-- | doc/development/documentation/topic_types/tutorial.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/development/documentation/topic_types/tutorial.md b/doc/development/documentation/topic_types/tutorial.md index b75b1e6b629..52f715cfcf3 100644 --- a/doc/development/documentation/topic_types/tutorial.md +++ b/doc/development/documentation/topic_types/tutorial.md @@ -25,6 +25,11 @@ In general, you might consider using a tutorial when: ideal to duplicate content that is available elsewhere, it's worse to force the reader to leave the page to find what they need. +## Tutorial file name and location + +For tutorial Markdown files, create a subfolder under `doc/tutorials`. +The tutorial file should be `index.md`. + ## Tutorial format Tutorials should be in this format: @@ -67,7 +72,7 @@ To do step 2: ``` An example of a tutorial that follows this format is -[Tutorial: Make your first Git commit](../../../tutorials/make_your_first_git_commit.md). +[Tutorial: Make your first Git commit](../../../tutorials/make_first_git_commit/index.md). ## Tutorial page title |