diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-12-14 16:03:22 -0200 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-12-14 16:03:22 -0200 |
| commit | 1a3362d76151b5eaef35fc058ce4b9c08ee6f2cd (patch) | |
| tree | 14f5bd6e38a06395178ccf061431b47b39996665 | |
| parent | 7446924921c6445872a83645514a366332246c15 (diff) | |
| download | gitlab-ce-docs-update-documentation-guidelines.tar.gz | |
change where we're placing new tech articlesdocs-update-documentation-guidelines
| -rw-r--r-- | doc/development/writing_documentation.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 42a7584751c..43a79ffcaa5 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -205,7 +205,7 @@ They are topic-related documentation, written with an user-friendly approach and A technical article guides users and/or admins to achieve certain objectives (within guides and tutorials), or provide an overview of that particular topic or feature (within technical overviews). It can also describe the use, implementation, or integration of third-party tools with GitLab. -They live under `doc/articles/article-title/index.md`, and their images should be placed under `doc/articles/article-title/img/`. Find a list of existing [technical articles](../articles/index.md) here. +They should be placed in a new directory named `/article-title/index.md` under a topic-related folder, and their images should be placed in `/article-title/img/`. For example, a new article on GitLab Pages should be placed in `doc/user/project/pages/article-title/` and a new article on GitLab CI/CD should be placed in `doc/ci/article-title/`. #### Types of Technical Articles |