Feature Proposal: Generate guidance in Markdown format
homebysix opened this issue · comments
Problem to solve
mSCP currently produces PDF, HTML, AsciiDoc, and Excel formatted guidance, but does not produce Markdown guidance.
Intended users
Many organizations utilize documentation systems that require (or prefer) Markdown formatted files. Such systems include MkDocs, GitBook, GitHub Pages, Hugo, Jekyll, and Sphinx.
Further details
Expanding to Markdown formatted guidance might lower friction required for some organizations to adopt the mSCP with their existing systems and tools.
Proposal
Modifications to the generate_guidance.py script would include the capability to templatize and output Markdown formatted files, as it currently does for other supported formats.
Documentation
Updates to the Generate Guidance wiki page would reflect the inclusion of Markdown in the supported output formats for guidance files.
Testing
Whatever tests are included in generate_guidance.py would need to support testing the Markdown output capabilities.
What does success look like, and how can we measure that?
Acceptance criteria for this feature request includes:
- generate_guidance.py produces Markdown formatted guidance files alongside currently supported formats
- Documentation for generating guidance is updated to reflect Markdown as a supported output format