Skip to content

Draft: Handbook page counts should exclude images

Neil McCorrison requested to merge handbook-page-counts-exclude-images into master

Why is this change being made?

Through evaluating our handbook's quantitative data I learned we are actually including images in the word count. The queries and screenshots below show that images and other non-markdown file types more than double the word count results. This MR updates our word count and printed page metrics.

Page in question: https://about.gitlab.com/handbook/about/#count-handbook-pages

Using the original command which includes all files.

find sites/handbook/source/handbook -type f | xargs wc -w

image

Using an adjusted command that looks only at markdown files.

find sites/handbook/source/handbook -type f -name "*.md" -o -name "*.md.erb" | xargs wc -w

image

Note: something is strange with the 2020-06-22 data. I'm getting a much lower number of markdown files. Between 03-22 and 06-22 there were 110 .erb and 337 .md files removed. I don't understand there the current data for 06-22 on the handbook came from.

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this change to the correct DRI(s)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR.
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Neil McCorrison

Merge request reports