What does this MR do?
As part of researching long options vs short options for Git in Verbose git command line arguments in empty rep... (!122213 - merged), I realized we had no style guide statement for our Git preferences. I knew, though, that we had a test to disallow short options in curl commands, though. I went looking in the style guide to find corroboration of the rule, and none existed.
Step 1 would be to put something into our testing page (https://docs.gitlab.com/ee/development/documentation/testing.html) that acknowledges
lint-doc.sh does more than the markdownlint testing described in https://docs.gitlab.com/ee/development/documentation/testing.html#lint-checks. I've created a very bare-bones section - it may or may not be in the right place on the page - so we at least acknowledge we're doing these checks.
It should probably also be in the style guide, but I had a total of ten minutes to make this MVC, and this is as far as I got.
I have thoughts, but not a decision, on the original question (long/short options for Git?) but it will help to at least have the decision for
curl documented as it's very similar.
- Related to Verbose git command line arguments in empty rep... (!122213 - merged)
- Related to Use verbose command line flags in empty reposit... (#412650)
Optional. Consider taking the GitLab Technical Writing Fundamentals course.
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:
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
These labels cause the MR to be added to code verification QA issues.
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 like
Default behavior when you close an issue.
The headings (other than the page title) should be active. Instead of
Configuring GDK, say something like
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.