Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-03-16 21:58:04 +0300
committerMarcia Ramos <virtua.creative@gmail.com>2017-03-16 21:58:04 +0300
commitdda8896e9382b6e306e8a06bf4bf144f0815c49c (patch)
treec53c44537d47adb886fcbe65ab638cfea9bab37d /doc/development/writing_documentation.md
parente4cd6c683be59b66778b9612f1cfbe0c3f740eee (diff)
rename "documentation articles" to "technical articles"
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r--doc/development/writing_documentation.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index 39a8204c629..c0440604297 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -1,10 +1,10 @@
# Writing Documentation
- **General Documentation**: written by the developers responsible by creating features. Should be submitted in the same merge request containing code. Feature proposals (by GitLab contributors) should also be accompanied by its respective documentation. They can be later improved by PMs and Technical Writers.
- - **Documentation Articles**: written by any GitLab Team member, GitLab contributors, or Community Writers.
+ - **Technical Articles**: written by any GitLab Team member, GitLab contributors, or Community Writers.
- **Indexes per topic**: initially prepared by the Technical Writing Team, and kept up-to-date by developers and PMs, in the same merge request containing code.
-## Distinction between General Documentation and Documentation Articles
+## Distinction between General Documentation and Technical Articles
Every **Documentation Article** contains, in the very beginning, a blockquote with the following information:
@@ -20,7 +20,7 @@ Every **Documentation Article** contains, in the very beginning, a blockquote wi
General documentation is categorized by _User_, _Admin_, and _Contributor_, and describe what that feature is, and how to use it or set it up.
-## Documentation Articles - Writing Method
+## Technical Articles - Writing Method
Use the [writing method](https://about.gitlab.com/handbook/marketing/developer-relations/technical-writing/#writing-method) defined by the Technical Writing team.