BCDevOps / developer-experience

This repository is used to track all work for the BCGov Platform Services Team (This includes work for: 1. Platform Experience, 2. Developer Experience 3. Platform Operations/OCP 3)
Apache License 2.0
8 stars 17 forks source link

Tech Docs IA change to support hierarchical relationships between pages #2748

Closed ty2k closed 2 years ago

ty2k commented 2 years ago

The information architecture (IA) of the Tech Docs site is currently flat. Pages are generated from Markdown documents that live in the ./src/docs/ folder, where the sub-directory structure denotes the menu group that documents will live in within the navigation menu.

It was determined in a June 7 Tech Docs content meeting that we would need a hierarchical relationship between pages, where certain topics that are broken into several documents (like Artifactory or Sysdig) would get parent landing pages that link to child content detail pages.

This will necessitate changes to:

Additional context

Definition of done

lukegonis commented 2 years ago

This issue is no longer needed/relevant