Skip to main content

Canonical Documentation Candidates

Markdown files identified as suitable for importing into Docusaurus as canonical documentation.

To be populated by reviewing Markdown inventory.

Criteria for Import​

A Markdown file is a candidate for canonical import if it:

  • Documents infrastructure, services, or operations
  • Is current and not obsolete
  • Does not contain sensitive data (passwords, keys, tokens)
  • Is well-structured and readable
  • Fits within the Docusaurus documentation scope

Candidates by Category​

Infrastructure Documentation​

FileLocationStatusNotes
(to be populated)———

Service Documentation​

FileLocationStatusNotes
(to be populated)———

Runbooks & Procedures​

FileLocationStatusNotes
(to be populated)———

Reports & Decisions​

FileLocationStatusNotes
(to be populated)———

Import Process​

For each candidate file:

  1. Review for sensitive content
  2. Update frontmatter (id, title, sidebar_position)
  3. Move to appropriate docs/ subdirectory
  4. Add to sidebars.js
  5. Test build: npm run build
  6. Deploy to VM700

Notes​

  • Do not import files with sensitive data
  • Prefer creating new pages over importing raw files
  • Consolidate related files into single pages where appropriate
  • Update this list as new candidates are identified