Git LFS page: build in more improvements
-
Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.
What does this MR do?
Now that we've landed a better / cleaner Git LFS page in !152451 (merged), let's start building in more of the info we've had outside the docs. This MR takes useful information from this googledoc (Fran, I miss your wisdom) and builds it into the page.
Before I send it for a tone and style review, I'll get a read-through from Support. The highlights:
- Build out the concept area. Fran had some great info here.
- Make the "configure your project" subheading a bit more robust. Begin touching on the idea of server config AND local config, and make "add file types to your
.gitattributes
file" a step there. - Split 'adding files to Git LFS' into two subheadings, as I originally intended: adding a single file, and adding a file TYPE.
- Moves another of the "limitations" into the proper spot.
Related issues
- Related to BE engineer + TW time to work on Git LFS docs (#419951 - closed) the tracking issue
- Related to Begin revisions of Git LFS page (!152451 - merged) which was the big ugly round of work
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details 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.