Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test Before Migrating Common Security Advisory Framework (CSAF) Documentation to MKDocs #71

Closed
wants to merge 2 commits into from

Conversation

santosomar
Copy link
Contributor

Fixes #70

This pull request migrates the Common Security Advisory Framework (CSAF) documentation to an MKDocs framework, enabling markdown (.md) support for streamlined editing, improved readability, and more efficient collaboration. Once we review the changes and new site, we can migrate the new docs to the root web folder.

Summary of Changes:

  • Documentation Reformat: Transformed all existing documentation into markdown format to align with MKDocs requirements.
  • MKDocs Setup: Configured MKDocs, including theme selection and settings adjustments, to enhance navigability and visual clarity.
  • Updated Links and Structure: Ensured internal links, table of contents, and document structure are compatible with markdown syntax and MKDocs navigation.

Benefits:

  • Markdown Support: Allows easy, Git-friendly documentation updates, suitable for technical and non-technical contributors.
  • Simplified Navigation: The MKDocs framework provides an intuitive, web-based structure for easy browsing using the readthedocs theme.
  • Improved Maintenance: Reduces barriers to documentation contributions by leveraging markdown’s simplicity.

Next Steps:

  • Validate links and formatting across all migrated pages.
  • Review navigation structure to ensure logical flow and accessibility.
  • Add additional sections or enhancements based on user feedback post-migration.

@santosomar santosomar self-assigned this Oct 29, 2024
@santosomar
Copy link
Contributor Author

Will close this and test in a separate effort/location.

@santosomar santosomar closed this Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate Common Security Advisory Framework (CSAF) Documentation to MKDocs
1 participant