website: adds content-check command and README update (#16579)

hashicorp · Mar 8, 2023 · e2c4a78 · e2c4a78
1 parent 9a5cb20
commit e2c4a78
Show file tree

Hide file tree

Showing 3 changed files with 2,236 additions and 119 deletions.
diff --git a/website/README.md b/website/README.md
@@ -100,6 +100,16 @@ The significant keys in the YAML frontmatter are:
 
 > ⚠️ If there is a need for a `/api/*` url on this website, the url will be changed to `/api-docs/*`, as the `api` folder is reserved by next.js.
 
+### Validating Content
+
+Content changes are automatically validated against a set of rules as part of the pull request process. If you want to run these checks locally to validate your content before comitting your changes, you can run the following command:
+
+```
+npm run content-check
+```
+
+If the validation fails, actionable error messages will be displayed to help you address detected issues.
+
 ### Creating New Pages
 
 There is currently a small bug with new page creation - if you create a new page and link it up via subnav data while the server is running, it will report an error saying the page was not found. This can be resolved by restarting the server.