UNCLASSIFIED - NO CUI

Skip to content

Resolve "Fix MkDocs Markdown formatting issues"

razzle requested to merge 1238-fix-mkdocs-markdown-formatting-issues into master

Ok, this MR might look scary but I promise you I didn't break anything! There was nothing deleted, only restructured / moved around or renamed.

Summary of changes:

  • Rename docs/developer/package-integration/* to remove package-integration from the doc name, was redundant
  • Fix Packages.md formatting
  • Run prettier against files I knew had Markdown formatting issues
  • Restructured docs/airgap, docs/developer, docs/guides, docs/k8s-storage, docs/example_configs
    • ^ Moved their configs, images, and other assets to a central docs/assets folder for cleaner docs management
    • Renamed some files for clarity, collapsed some folder structures
    • Reflected the above restructuring in the values files, ie docs/example_configs became docs/assets/configs/example

It would be worth to git checkout 1238-fix-mkdocs-markdown-formatting-issues or use this link and perusing the restructured docs folder.

EDIT: Enforced file naming convention within docs folder

Enforced lowercase w/ - word separator over _. For clarity and uniformity.

For Issue

Closes #1238 (closed)

Edited by razzle

Merge request reports

Loading