Docs: instructions for collapsing generated files
What does this MR do?
This merge request addresses the docs questions from !141576 (merged) that were moved to follow-up #438340 (closed) so they wouldn't block the feature. This merge request:
- Adds a new subheading to
doc/user/project/highlighting.md
to explain what to put in the.gitattributes
file. - Cross-links from the API page (
doc/api/merge_requests.md
) to the highlighting page. - Shortens the language in
doc/user/project/merge_requests/changes.md
and points to the highlighting page.
I know that I need a code example for doc/user/project/highlighting.md
, and the technical reviewer may have feelings about whether the home for the instructions should be either ...
- in
doc/user/project/highlighting.md
with the rest of the.gitattributes
info? - in
doc/user/project/merge_requests/changes.md
with the rest of the information about collapsing generated files?
I'm open to either option.
Related issues
- Related to Add generated_file to Diffs API (!141576 - merged) where the feature was added
- Closes Follow-up from "Add generated_file to Diffs API" (#438340 - closed) where we moved the follow-ups from the feature MR
- Related to #391778 (closed) where the field was added to the APIs
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
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.