Skip to content

Adds a new page about building installing packages

Katie Macoy requested to merge 376359-package-docs-build-info into master

What does this MR do and why?

This MR is the first of many that came out of conversations on https://gitlab.com/gitlab-org/gitlab/-/issues/376359

The package docs are very long and contain lots of information. We learned that customers are confused about how to authenticate to the registries (dovetail insight). In order to simplify the docs, we will be splitting up the information onto smaller pages and standardizing the format of each page.

The planned MRs are:

  1. Create a new page listing the install/build instructions that are on each package format page 👈 you are here
  2. Add this page to page navigation
  3. Remove install/build instructions from individual package pages + link to this new page from each package format page. (11 MRs, one per format)
  4. Standardize each package format page to follow the structure: authenticate, publish, install (11 MRs, one per format)
  5. Create new page for authentication best practices
  6. Add authentication best practices to navigation
  7. Link from package format pages to authentication best practices

How to set up and validate locally

It will not be possible to view this locally as this page does not exist in the navigation yet. Adding the page into the navigation requires a separate MR as gitlab and gitlab-docs are separate git projects. gitlab handles changes to documentation pages (like this MR) and gitlab-docs handles changes to the navigation.

When this MR is merged, I will create a follow-up MR to add this page to the site navigation in the gitlab-docs git project.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #376359

Merge request reports