Improve navigation for documentation for Package features

Problem to solve

The GitLab Package Registry consists of the Container Registry, the Maven Repository, the NPM Registry, the Dependency Proxy and will soon include other package manager integrations as well.

We are currently working to combine category definitions and the overall navigation for the Package stage. We must ensure that our documentation follows suit.

Proposal

We have an issue scheduled that will combine navigation of Package features under a new top-level nav called "Packages" I think we should do the same thing for our documentation.

For user guides, we will add a section called "Packages" and have the following sub-sections:

Subject Status Link
Introduction Does not exist n/a
Examples Available https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#using-the-gitlab-container-registry
Container Registry Available https://docs.gitlab.com/ee/user/project/container_registry.html
Maven Repository Available https://docs.gitlab.com/ee/user/project/packages/maven_repository.html
NPM Registry Available https://docs.gitlab.com/ee/user/project/packages/npm_registry.html
Dependency Proxy Available https://docs.gitlab.com/ee/user/group/dependency_proxy/

For administrator guides, the Package features currently live in project settings which seems inaccurate anyway, since many of the features work at the group/instance level. We could add section called "Package Registry" and nest the following documentation under there.

Subject Status Link
Container Registry Available https://docs.gitlab.com/ee/administration/container_registry.html
Packages Available, already combines Maven/npm https://docs.gitlab.com/ee/administration/packages.html
Dependency Proxy Available https://docs.gitlab.com/ee/administration/dependency_proxy.html

Further details

Who can address the issue

Someone familiar with GitLab docs and how to make navigational updates.

Other links/references

  • MR that combines all of the individual package manager integrations into one category
  • Top-level navigation issue for Package
  • Package direction / vision page
Edited Aug 08, 2019 by Tim Rizzi
Assignee Loading
Time tracking Loading