teamniteo/handbook

Arrange the handbook pages into sub-folders

cas-- opened this issue · 6 comments

cas-- commented

The Story

As an Nitean,
I want the handbook to be easier to navigate,
so that I can quickly look up company information.

Description

Problem/Task

The handbook is a flat-file structure so there is no grouping of similar topics making file-browser navigation harder.

Proposal

  • Arrange the handbook pages into subfolders
  • Update the index.md and other pages to point to new locations.
  • Update templates to point to new locations.

Pitfalls

Break handbook links from places not considered

Best Practices (DoD)

  • Documentation is up-to-date:
    • Handbook pages
    • Intra docs or reports
    • Sphinx technical docs

Expectations (AC)

  • The handbook pages are organised into folders.
  • Links to the handbook pages in templates are correct
  • User Story Demo uploaded to Sprint release.
cas-- commented

SP: 1

zupo commented

SP: 1

dmurko commented

SP: 1 as long as it doesn't expand into other fixes.

suzil commented

SP: 1

marbeann commented

SP: 1

cas-- commented

Ticked:

  • The handbook pages are organised into folders.
  • Links to the handbook pages in templates are correct
  • User Story Demo uploaded to Sprint release.