Skip to content

Update Maven documentation

Katie Macoy requested to merge 376359-maven-documentation into master

What does this MR do and why?

This MR is a part of a larger effort to standardize and simplify the package documentation. In !104645 (merged) we created a format that package documentation would follow:

The structure proposed is:

  • introduction
  • publish a package
  • install a package
  • helpful hints
  • troubleshooting

This MR bring Maven to that format. It also moves all Gradle documentation to its own page.

Screenshots or screen recordings

Before After
prodMaven_packages_in_the_Package_Repository___GitLab gdk_Maven_packages_in_the_Package_Registry___GitLab

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Enable gitlab docs in the gdk https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/gitlab_docs.md
  2. Visit Maven package format page

Note: It will not be possible to view the gradle page as it does not exist the main navigation yet. I will create a separate MR for that change.

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

Edited by Katie Macoy

Merge request reports