Commit 84734aaa authored by Achilleas Pipinellis's avatar Achilleas Pipinellis 🚀

Merge branch 'documentation-page-remove-duplicate-content' into 'master'

Remove duplicate content and improve intro and SSOT section to link to docs

See merge request !21531
parents 3cf45f1a 099afc8a
Pipeline #57093516 passed with stages
in 34 minutes and 19 seconds
......@@ -9,6 +9,8 @@ The documentation is an essential part of the product. Its source is developed a
It is GitLab’s goal to create documentation that is complete, accurate, and easy to use. It should be easy to browse or search for the information you need, and easy to contribute to the documentation itself.
All standards and practices for contributing documentation are found within the docs in the [GitLab Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/) section.
## On this page
{:.no_toc}
......@@ -17,28 +19,13 @@ It is GitLab’s goal to create documentation that is complete, accurate, and ea
## Documentation as Single Source of Truth (SSOT)
The documentation is the SSOT for all information related to the implementation, usage, and troubleshooting of GitLab products and features. It evolves continually in keeping with new products and features, and with improvements for clarity, accuracy, and completeness.
The documentation is a continually evolving SSOT for all information related to the implementation, usage, and troubleshooting of GitLab products and features.
This policy prevents information silos, ensuring that it remains easy to find information about GitLab products.
It also informs decisions about the kinds of content we include in our documentation.
### Content we include
As the single source of truth, we include any and all information that may be helpful to the aforementioned audiences and goals.
* This may include (or may link to) helpful content that was not created specifically
for the documentation, including presentations, diagrams, videos, etc.
* We do not withhold workarounds for a single release/time period/niche case, or code that could be construed as dangerous to run, provided that we offer fully detailed warnings and context alongside it. This kind of content should be included in the docs for applicable products/versions, as it could be helpful to others and, when properly explained, its benefits outweigh the risks. If you think you have found an exception to this rule, contact the Technical Writing team.
For detailed standards, see the [Content](https://docs.gitlab.com/ee/development/documentation/styleguide.html#content) section in the [Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html).
### Content organization
We organize content by topic, not by type, so that it can be located as easily as possible within the "single source of truth" section for the subject matter.
It also informs decisions about the kinds of content we include in our documentation and how we organize it.
For detailed standards, see [Documentation types and organization](https://docs.gitlab.com/ee/development/documentation/#documentation-types-and-organization) within the [GitLab Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/).
For more information, see the [Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide.html) sections on Content and Structure.
## Docs-first methodology
......
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