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

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2022-05-20 03:22:46 +0300
committerEvan Read <eread@gitlab.com>2022-05-20 03:22:46 +0300
commit5a7f8c1b809085a8ecc2748f1b2f0351b953ba6e (patch)
tree2de1023afd591a3635bf2d16eb4a356e9d99fc1c /doc
parentf7fe0b883ba66857ec38674d77d54c6a3caedd95 (diff)
Refactor index page of documentation for project
Diffstat (limited to 'doc')
-rw-r--r--doc/index.md45
1 files changed, 12 insertions, 33 deletions
diff --git a/doc/index.md b/doc/index.md
index 63f90f52..9f003791 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -1,8 +1,6 @@
# GitLab Docs site
-## Projects we pull from
-
-There are currently 5 products that are pulled and generate the docs website:
+The GitLab Docs site comprises documentation from the following projects:
- [GitLab](https://gitlab.com/gitlab-org/gitlab)
- [Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab)
@@ -10,38 +8,19 @@ There are currently 5 products that are pulled and generate the docs website:
- [GitLab Chart](https://gitlab.com/gitlab-org/charts/gitlab)
- [GitLab Operator](https://gitlab.com/gitlab-org/gitlab-operator)
-NOTE:
-Although GitLab Community Edition is generated, it is hidden from the website
-as it's the same as the Enterprise Edition. We generate it for consistency,
-until [better redirects](https://gitlab.com/gitlab-org/gitlab-pages/issues/24)
-are implemented.
-
-## Development when contributing to GitLab documentation
-
-This section is about contributing to one of the GitLab
-[projects' documentation](#projects-we-pull-from), and preview your changes at
-the same time.
-
-Before diving into writing, here are two handy links:
-
-- [Writing documentation](https://docs.gitlab.com/ee/development/documentation/index.html)
-- [Style guide](https://docs.gitlab.com/ee/development/documentation/styleguide/index.html)
-
-There are multiple ways to preview GitLab documentation changes, you can:
+This project can be used to:
-- You can [build and run the docs site locally](setup.md).
-- You can [create a Review App with each merge request](https://docs.gitlab.com/ee/development/documentation/index.html#previewing-the-changes-live),
- if you are a GitLab team member.
-- You can [use GDK for documentation development](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/gitlab_docs.md).
+- [Build and run](setup.md) the GitLab Docs site locally, to preview changes you make to the documentation.
+- [Develop](development.md) and [test](testing.md) the GitLab Docs site itself.
-## Develop and maintain the docs site
+If you use GDK, you can also [use GDK for documentation development](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/gitlab_docs.md).
-If you are interested in making contributions to the GitLab documentation site itself,
-see the [GitLab docs site development](development.md) and [Testing the GitLab docs site](testing.md) pages.
+## Technical Writing team member tasks
-GitLab technical writing team members sometimes have to do maintenance tasks:
+GitLab [Technical Writing team members](https://about.gitlab.com/handbook/engineering/ux/technical-writing/) perform
+the following maintenance tasks on the GitLab Docs site:
-- Publish the [next release of the GitLab docs site](releases.md).
-- Perform [GitLab docs site maintenance](maintenance.md).
-- Run [GitLab docs rake tasks](raketasks.md).
-- Refine the [search results using DocSearch](docsearch.md).
+- Publish [releases](releases.md).
+- Perform [maintenance](maintenance.md).
+- Run [Rake tasks](raketasks.md).
+- Refine [search results](docsearch.md).