Skip to content

Initial idea for a front matter test

Amy Qualls requested to merge docs-aqualls-frontmatter-test into master

What does this MR do?

It would be helpful if the TW team could catch new documentation pages that were added to the repository sans front matter. (For those not on the team: we use front matter to track page ownership by stage and group.)

When I first created this MR, this merge request SHOULD have failed, because three new files had been added without frontmatter (list below). However, since this MR was created, these pages have since been fixed:

./development/integrations/codesandbox.md
./api/graphql/removed_items.md
./administration/integration/kroki.md

RESOLVED However, I've marked it as WIP because I'm getting a syntax error in the file:

scripts/lint-doc.sh: line 142: syntax error near unexpected token `fi'
scripts/lint-doc.sh: line 142: `fi'

Steps:

  1. Fix the syntax error.
  2. Ensure this new test works properly when results are found.
  3. Ensure it also works properly when NO results are found (AKA all files have front matter)

Idea combined together from command-line suggestions on these pages.

Related issues

Closes #298761 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Amy Qualls

Merge request reports