Content audit simplification

Simplifies the content audit by collating all the output files as single files that can be copied + pasted into the audit directly.

  • New script quarterly-content-audit-combine.py that takes the output files produced by the existing script, applies all the necessary adjustments (that we previously did manually in the spreadsheets), and creates combined comma-separated files with all the data from each repo.
  • Update the pipeline to include a new stage collect-data
  • Removes an unnecessary header from the existing navigation script.

Companion MR to update the instructions: https://gitlab.com/gitlab-com/content-sites/internal-handbook/-/merge_requests/8612

Testing steps

You're going to test that this MR creates a successful pipeline to build the content audit artifacts, and that the artifacts contain the data you need for the audit.

  1. In this project, select Build > Pipelines > New pipeline.
  2. Select the branch kpaizee-content-audit-redo (the branch for this MR) under Run for branch name or tag.
  3. Enter the variable key CONTENT_AUDIT with value true.
  4. Select New pipeline.
  5. When the pipeline completes, select the combine-data job and download the artifacts.
  6. When it's finished downloading, unzip the artifacts.zip file.

The file should contain:

  • combined-assign.csv
  • combined-files.csv
  • combined-titles.csv
  • combined-words.csv
  • combined-read.csv
  • navigation-urls.csv

Open and spot check to ensure the files are populated, and contain comma-separated lines. E.g. the combined-titles.csv should look like this:

./_index.md,GitLab Docs,
./administration/_index.md,Administer GitLab,
./administration/admin_area.md,GitLab Admin area,"Free, Premium, Ultimate"
./administration/administer_users.md,Administer users,"Free, Premium, Ultimate"
./administration/analytics.md,Use ClickHouse for analytics reports,"Free, Premium, Ultimate"
./administration/analytics/devops_adoption.md,DevOps adoption by instance,"Free, Premium, Ultimate"
./administration/analytics/usage_trends.md,Usage trends,"Free, Premium, Ultimate"
./administration/appearance.md,GitLab appearance,"Free, Premium, Ultimate"
...

Known issues

These are existing issues, will address in follow-up:

  • Home page filepath ends in double // which currently has to be manually removed
  • Titles script is also fetching the markdown link for 'Free' (for the pages that describe DAP features that use credits). Need to build in logic to strip that out.
Edited by Kati Paizee

Merge request reports

Loading
Loading