Adds hard wraps to lines to get below maximum
-
Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.
What does this MR do?
As part of prep work to enforce (#467298 (closed)) length limits on subheadings in our docs, we have to work around a quirk of Markdownlint. We can't set a length for headers without setting a limit for standard lines, so we've picked something big — 800 characters.
This merge request adds hard line wraps to doc/legal/corporate_contributor_license_agreement.md
. I've separated this one change out from all the others because I expect changes to any file in doc/legal
need more oversight — even if it's just line wrappings, like this MR.
Details in case someone in Legal is curious
To implement the line-length change, we have to edit .markdownlint-cli2.yaml
in the root of the gitlab
repo. Right now, the line-length rule is disabled. To enable it, it has to be set like this:
line-length: # MD013
code_blocks: false
tables: false
headings: true
heading_line_length: 100
line_length: 800
If we set heading_line_length
but do not set line_length
, line_length
defaults to 80. We're intentionally picking an extremely large number - 800! - to try to trigger as few problems as possible.
Related issues
Related to Track subheading length improvements (#467298 - closed)
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.