Skip to content

Make Job Family pages dynamic

Chad Woolley requested to merge make-job-family-pages-dynamic into master

What does this MR do?

Makes Job Family structure pages dynamically render via middleman, rather than just linking to the raw file in the repository.

Background

This problem was reported by Sid in the #handbook-escalation channel on Slack:

Sid Dec 1st at 4:37 PM

jr

I've noticed that the links in many job family entries are broken in the repository browsing view that we direct readers to by default now. These relative links work when you click "View on about.gitlab.com" but that's not intuitive or obvious for many visitors.

See the attached screencap for a demonstration of what I mean.

This confused a prospective candidate today. Do we have a plan or work-in-flight to improve this experience? Should we transition to absolute links in our job family descriptions? What about an auto-generated markdown "table of contents" for this piece of our handbook?

Screen_Recording_2020-11-24_at_3.28.45_PM

Known Issues

  1. There are a few existing pages which do not follow the convention and should be cleaned up, e.g. 'Overview' pages, and Fullstack Engineer.
  2. There is a simple "#titleize" used to form all link text, which results in some slightly incorrect casing for acronyms, such as "Vp Of Alliances" and "It Helpdesk Analyst"

Testing

Go to /job-families in the review app and click through to various job family categories and individual roles.

Edited by Chad Woolley

Merge request reports

Loading