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
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.
[ ] Documents directory structure is updated to reflect hierarchical site IA
[ ] Navigation menu allows navigation to parent/landing pages. Navigation to child pages can be limited to links on the parent/landing pages in order to keep the overall length of the navigation menu shorter.
[ ] Visual breadcrumbs appear at the top of the page to show the page's location in the IA
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:
docs
folder directory structureAdditional context
Definition of done