Merge branch 'docs-aqualls-frontmatter-test' into 'master'

Initial idea for a front matter test

See merge request gitlab-org/gitlab!52844

doc/development/documentation/index.md

@@ -96,18 +96,18 @@ belongs to, as well as an information block as described below:
   https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
   ```
 
-For example, the following metadata would be at the beginning of a product
-documentation page whose content is primarily associated with the Audit Events
-feature:
+For example:
 
 ```yaml
 ---
-stage: Monitor
-group: APM
+stage: Example Stage
+group: Example Group
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
 ---
 ```
 
+If you need help determining the correct stage, read [Ask for help](workflow.md#ask-for-help).
+
 ### Document type metadata
 
 Originally discussed in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/1280),

doc/development/documentation/workflow.md

@@ -65,13 +65,15 @@ To update GitLab documentation:
 NOTE:
 Work in a fork if you do not have Developer access to the GitLab project.
 
-Request help from the Technical Writing team if you:
+### Ask for help
+
+Ask for help from the Technical Writing team if you:
 
 - Need help to choose the correct place for documentation.
 - Want to discuss a documentation idea or outline.
 - Want to request any other help.
 
-To request help:
+To identify someone who can help you:
 
 1. Locate the Technical Writer for the relevant
    [DevOps stage group](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).

scripts/lint-doc.sh

@@ -18,6 +18,18 @@ then
   ((ERRORCODE++))
 fi
 
+# Documentation pages need front matter for tracking purposes.
+echo '=> Checking documentation for front matter...'
+echo
+no_frontmatter=$(find doc -name "*.md" -exec head -n1 {} \; | grep -v  --count -- ---)
+if [ $no_frontmatter -ne 0 ]
+then
+  echo '✖ ERROR: These documentation pages need front matter. See https://docs.gitlab.com/ee/development/documentation/index.html#stage-and-group-metadata for how to add it.' >&2
+  find doc -name "*.md" -exec sh -c 'if (head -n 1 "{}" | grep -v -- --- >/dev/null); then echo "{}"; fi' \; 2>&1
+  echo
+  ((ERRORCODE++))
+fi
+
 # Test for non-standard spaces (NBSP, NNBSP) in documentation.
 echo '=> Checking for non-standard spaces...'
 echo