summaryrefslogtreecommitdiff
path: root/doc/development
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2018-05-09 11:07:11 +0000
committerAchilleas Pipinellis <axil@gitlab.com>2018-05-09 11:07:11 +0000
commitf703ba3f8530c7e9c7b94ffbcb281bd877f8d0ab (patch)
tree102edbccadda808de7e963566661ad392d2fafc3 /doc/development
parent3d93ad103b32b71d4af330c17227c23a2a167bae (diff)
downloadgitlab-ce-f703ba3f8530c7e9c7b94ffbcb281bd877f8d0ab.tar.gz
Docs: add custom descriptions to most relevant docs
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/README.md1
-rw-r--r--doc/development/doc_styleguide.md4
-rw-r--r--doc/development/writing_documentation.md4
3 files changed, 9 insertions, 0 deletions
diff --git a/doc/development/README.md b/doc/development/README.md
index 32ae86a7150..898c60e96c0 100644
--- a/doc/development/README.md
+++ b/doc/development/README.md
@@ -1,5 +1,6 @@
---
comments: false
+description: 'Learn how to contribute to GitLab.'
---
# GitLab development guides
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index 5da015ca557..540e39aabbd 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -1,3 +1,7 @@
+---
+description: 'Writing styles, markup, formatting, and reusing regular expressions throughout the GitLab Documentation.'
+---
+
# Documentation style guidelines
The documentation style guide defines the markup structure used in
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index 9bca4637830..fb7da82977b 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -1,3 +1,7 @@
+---
+description: Learn how to contribute to GitLab Documentation.
+---
+
# GitLab Documentation guidelines
- **General Documentation**: written by the [developers responsible by creating features](#contributing-to-docs). 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.