diff options
author | Evan Read <eread@gitlab.com> | 2022-05-19 07:54:09 +0300 |
---|---|---|
committer | Evan Read <eread@gitlab.com> | 2022-05-19 07:57:11 +0300 |
commit | cd43037759b46b7f737527252937ddc2ccb8062a (patch) | |
tree | c9a661cff3cb86ad45b1402ac3b8e1cd8ab2ee39 /README.md | |
parent | 2e1563b0cf3d1302c704d34a14db35080a33541a (diff) |
Remove duplication on README.md file
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 5 insertions, 21 deletions
@@ -1,27 +1,11 @@ -# GitLab documentation project +# GitLab Docs project -[![build status](https://gitlab.com/gitlab-org/gitlab-docs/badges/main/pipeline.svg)](https://gitlab.com/gitlab-org/gitlab-docs/commits/main) +This project generates and deploys the GitLab documentation website to <https://docs.gitlab.com>. -This project hosts the repository used to generate the GitLab documentation -website deployed to [https://docs.gitlab.com](https://docs.gitlab.com). It -uses the [Nanoc](http://nanoc.ws) static site generator. +For information on: -## Contribution - -If you are interested in contributing improvements to how the <https://docs.gitlab.com> **site** itself works, -see the [GitLab docs site documentation](doc/index.md) - -If you are interested in contributing to the **documentation** for specific GitLab products, -you must contribute the documentation changes in the projects for those products: - -- [GitLab](https://gitlab.com/gitlab-org/gitlab) -- [Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab) -- [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) -- [GitLab Chart](https://gitlab.com/gitlab-org/charts/gitlab) -- [GitLab Operator](https://gitlab.com/gitlab-org/cloud-native/gitlab-operator) - -If you want to preview your documentation changes and see how they would appear on -<http://docs.gitlab.com>, there are a few ways to [preview GitLab documentation changes](doc/index.md#development-when-contributing-to-git-lab-documentation). +- This project, see the [GitLab Docs site](doc/index.md). +- Contributing to GitLab documentation content, see [GitLab Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/). ## Contributing agreement |