Draft: Split repositories API page, preserve all histories
What does this MR do?
This page https://docs.gitlab.com/ee/api/repositories.html contains a LOT of information that shouldn't be in an API page. Starting with Add changelog data to a changelog file, it's a set of subheadings that are really about using our Changelog feature.
This MR performs an octopus merge of aqualls-strip-user-info-from-api-page
and aqualls-move-changelog-info
into aqualls-octopus-garden-merge
, like this:
graph TD
A[aqualls-strip-user-info-from-api-page] -->|cuts out user docs<br>from existing API page| C
B[aqualls-move-changelog-info] -->|copy full file to new user docs page,<br>delete API info from it| C{aqualls-octopus-garden-merge}
C -->|fa:fa-heart sob with joy| F[now start editing<br>new user docs page]
- carve out part of
doc/api/repositories.md
- move JUST the user-docs portion over to a new page (current proposal is
doc/user/project/repository/changelog.md
) - API portions of the page stay at
doc/api/repositories.md
- ☆☆☆ preserve Git history in both places ☆☆☆
Related issues
- Related to Draft: Split apart repositories API page, prese... (!106098 - closed) which was my first try at this octopus merge
- Related to Draft: second test for repositories API page split (!106099 - closed) which was my second try at this octopus merge
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.