Skip to content

Hoist markdownlint to root

What does this MR do?

This hoists markdownlint tooling/configuration to the root.

This may be easier to review commit-by-commit.

Part of #2034 (closed).

Commits

Fix markdown lints

The next commit will enable linting for these files, so fix the lints first.

Hoist markdownlint to root

We're sticking with markdownlint-cli2, since it is a bit more flexible for our needs than markdownlint-cli.

See https://dlaa.me/blog/post/markdownlintcli2 for more information about the design goals of markdownlint-cli2.

Part of #2034 (closed).

Use lint: prefix for markdownlint script

This is to follow the convention used for eslint and prettier.

Screenshots or screen recordings

N/A

Integrations

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
    • For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
  • Relevant label(s) are applied to the MR.
  • The MR is added to a milestone.
  • Added the ~"component:*" label(s) if applicable.

Components

Documentation

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Mark Florian

Merge request reports

Loading