Commit 2e5871f3 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'doc-style-guide-files-hyphens-underscores' into 'master'

Fix underscores vs hyphens content in Doc Style Guide

See merge request gitlab-org/gitlab!38099
parents d87581da 5a9df82f
...@@ -191,10 +191,10 @@ The table below shows what kind of documentation goes where. ...@@ -191,10 +191,10 @@ The table below shows what kind of documentation goes where.
Do not use another file name and **do not** create `README.md` files. Do not use another file name and **do not** create `README.md` files.
1. **Do not** use special characters and spaces, or capital letters in file names, 1. **Do not** use special characters and spaces, or capital letters in file names,
directory names, branch names, and anything that generates a path. directory names, branch names, and anything that generates a path.
1. When creating a new document and it has more than one word in its name, 1. When creating or renaming a file or directory and it has more than one word in its name,
make sure to use underscores instead of spaces or dashes (`-`). For example, use underscores (`_`) instead of spaces or dashes. For example,
a proper naming would be `import_projects_from_github.md`. The same rule proper naming would be `import_project/import_from_github.md`. This applies to
applies to images. image files as well as Markdown files.
1. For image files, do not exceed 100KB. 1. For image files, do not exceed 100KB.
1. Do not upload video files to the product repositories. 1. Do not upload video files to the product repositories.
[Link or embed videos](#videos) instead. [Link or embed videos](#videos) instead.
...@@ -216,7 +216,7 @@ The table below shows what kind of documentation goes where. ...@@ -216,7 +216,7 @@ The table below shows what kind of documentation goes where.
the **Visibility and Access Controls** category should have a document the **Visibility and Access Controls** category should have a document
located at `doc/user/admin_area/settings/visibility_and_access_controls.md`. located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
1. The `doc/topics/` directory holds topic-related technical content. Create 1. The `doc/topics/` directory holds topic-related technical content. Create
`doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary. `doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary.
General user- and admin- related documentation, should be placed accordingly. General user- and admin- related documentation, should be placed accordingly.
1. The directories `/workflow/`, `/university/`, and `/articles/` have 1. The directories `/workflow/`, `/university/`, and `/articles/` have
been **deprecated** and the majority their docs have been moved to their correct location been **deprecated** and the majority their docs have been moved to their correct location
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment