Add navigation-related content audit scripts
Adds content audit scripts to the project.
-
check-pages-not-in-nav
is ported over from gitlab-docs. We created that previously here: gitlab-docs!3236 (merged) -
check-page-nav-titles
is new and closes gitlab-docs#1575 (closed)
We're putting content audit scripts in this project because:
- They add dependencies that are not needed for docs.gitlab.com (e.g, a CSV parser), and these dependencies are less important to update weekly like we do on the gitlab-docs project.
- They only need to be used locally by technical writers who are analyzing site content, so we can relax coding standards like test coverage a bit in order to answer content-related questions quickly.
Example output
A CSV created from check-page-nav-titles
:
https://docs.google.com/spreadsheets/d/1v8N9IDWjEjZGnsNznwtY3adjmrgusapvixCiX4QaFQY/edit#gid=296753629
Output from check-pages-not-in-nav
is unchanged; this returns JSON. To view a list of just URLs, run make check-pages-not-in-nav | jq '.[] | .url'
, same as it was in the other project.
Edited by Sarah German