diff options
| -rw-r--r-- | doc/README.md | 9 | ||||
| -rw-r--r-- | doc/development/doc_styleguide.md | 4 | ||||
| -rw-r--r-- | doc/development/writing_documentation.md | 2 | ||||
| -rw-r--r-- | doc/topics/index.md | 16 |
4 files changed, 14 insertions, 17 deletions
diff --git a/doc/README.md b/doc/README.md index 1ffe22b3c88..2a72c15a43d 100644 --- a/doc/README.md +++ b/doc/README.md @@ -11,17 +11,12 @@ All technical content published by GitLab lives in the documentation, including: - Admin guides: technical content to guide administrators of GitLab instances from point A to point B - Technical Overviews: technical content describing features, solutions, and third-party integrations - Tutorials: technical content provided step-by-step on how to do things, or how to reach very specific objectives -- **[Indexes per Topic](topics/)**: content gathering all resources already published by GitLab related to an specific subject or theme, including: +- **[Topics](topics/)**: indexes pages organized per topic, gathering all resources already published by GitLab related to an specific subject or theme, including: - General Docs - Technical Articles - Blog Posts - Video Tutorials -See also: - -- [Distinction between General Documentation and Technical Articles](development/writing_documentation.md#distinction-between-general-documentation-and-technical-articles) -- GitLab [University](university/README.md): guides to learn Git and GitLab through courses and videos. - ## User Documentation - [Account Security](user/profile/account/two_factor_authentication.md) Securing your account via two-factor authentication, etc. @@ -88,4 +83,6 @@ See also: - [Development](development/README.md) All styleguides and explanations how to contribute. - [Writing documentation](development/writing_documentation.md) +- [Distinction between General Documentation and Technical Articles](development/writing_documentation.md#distinction-between-general-documentation-and-technical-articles) +- [GitLab University](university/README.md): guides to learn Git and GitLab through courses and videos. - [Legal](legal/README.md) Contributor license agreements. diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 3c755c192fa..bb78a0de0c5 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -3,6 +3,8 @@ This styleguide recommends best practices to improve documentation and to keep it organized and easy to find. +See also [writing documentation](writing_documentation.md). + ## Location and naming of documents >**Note:** @@ -59,7 +61,7 @@ The table below shows what kind of documentation goes where. located at `doc/user/admin_area/settings/visibility_and_access_controls.md`. 1. The `doc/topics/` directory holds topic-related technical content. Create `doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary. - Note that `topics` holds the index page per topic, and techical articles. General + Note that `topics` holds the index page per topic, and technical articles. General user- and admin- related documentation, should be placed accordingly. --- diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index ca0d8a3f775..e1ca6a43628 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -67,7 +67,7 @@ Use the [writing method](https://about.gitlab.com/handbook/product/technical-wri ## Documentation Style Guidelines -All the documentation follow the same [styleguide](https://docs.gitlab.com/ce/development/doc_styleguide.html). +All the documentation follow the same [styleguide](doc_styleguide.html). ### Markdown diff --git a/doc/topics/index.md b/doc/topics/index.md index aaba4aefbfc..ef6f68f50d7 100644 --- a/doc/topics/index.md +++ b/doc/topics/index.md @@ -1,13 +1,11 @@ -# Indexes per Topic +# Topics -**Indexes per Topic** gather all resources already published by GitLab -related to an specific subject or theme, including: - - General Docs - - Technical Articles - - Blog Posts - - Video Tutorials - -## Topics +We have organized our content resources into topics +to get you started on areas of your interest. Each topic page +consists of an index listing all related content. It will guide +you through better understanding GitLab's concepts +through our regular docs, and, when available, through articles (guides, +tutorials, technical overviews, blog posts) and videos. - Idea to Production - [GitLab Installation](../install/README.md) |