Commit 12db688a authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski
Browse files

Merge branch 'readme' into 'main' 

Update README to note new project location

See merge request !5367



Merged-by: default avatarMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>
Approved-by: default avatarMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>
Co-authored-by: Sarah German's avatarSarah German <sgerman@gitlab.com>
parents dfeddbb7 3ba4a947

.gitlab/ci/test.gitlab-ci.yml

+15 −12
Original line number Diff line number Diff line
@@ -21,18 +21,21 @@ include: 
#

# Test the links in the global nav for all MRs in `gitlab-docs`

#

test_global_nav_links:

  image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-html:alpine-3.20-ruby-3.2.4-3664e560

  extends:

    - .rules_site_tests

    - .bundle

  stage: test

  script:

    # Only check files in top-level directories. This means a much faster and less repetitive check of global navigation links.

    - echo "  all:" >> nanoc.yaml

    - echo "    exclude_files:" >> nanoc.yaml

    - echo "      - '\/(ee|runner|omnibus|charts|operator)\/.*\/.*'" >> nanoc.yaml

    - "parallel time bundle exec nanoc check ::: internal_links internal_anchors"

# This test no longer passes with the launch of the new site,

# so it is no longer active on the pipeline.

#

# test_global_nav_links:

#   image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-html:alpine-3.20-ruby-3.2.4-3664e560

#   extends:

#     - .rules_site_tests

#     - .bundle

#   stage: test

#   script:

#     # Only check files in top-level directories. This means a much faster and less repetitive check of global navigation links.

#     - echo "  all:" >> nanoc.yaml

#     - echo "    exclude_files:" >> nanoc.yaml

#     - echo "      - '\/(ee|runner|omnibus|charts|operator)\/.*\/.*'" >> nanoc.yaml

#     - "parallel time bundle exec nanoc check ::: internal_links internal_anchors"



#

# Check the redirect file for duplicates

README.md

+16 −8
Original line number Diff line number Diff line 
# GitLab Docs project

# GitLab Docs project (Legacy)



This project generates and deploys the GitLab documentation website to <https://docs.gitlab.com>.

This repository contains the original GitLab documentation website that served `docs.gitlab.com` from December 2016 to February 2025. The site was built using [Nanoc](https://nanoc.app/).



For information on:

## Important notice: docs website has moved



- The build and deployment process, see [doc/index.md](doc/index.md).

- Editing GitLab documentation, see [GitLab Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/).

The GitLab Docs website codebase has moved to a new location:

https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com



See also:

### For documentation issues



  * [CONTRIBUTING.md](CONTRIBUTING.md): information about the Developer Certificate of Origin and rights licensing.

  * [LICENSE](LICENSE): MIT License.
 
- For issues related to the docs website, please create them at:

  https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/issues

- For documentation content issues, please refer to:

  https://docs.gitlab.com/development/documentation/



## Additional information



- [LICENSE](LICENSE): MIT License



Note: The Docker images in this repository remain available as they contain version-specific documentation that matches past GitLab releases.