oscal-compass / compliance-trestle

An opinionated tooling platform for managing compliance as code, using continuous integration and NIST's OSCAL standard.
https://oscal-compass.github.io/compliance-trestle
Apache License 2.0
157 stars 60 forks source link

Various website enhancements #1677

Open butler54 opened 2 weeks ago

butler54 commented 2 weeks ago

Issue description / feature objectives

This is a bit of a list of things to do in the website for compliance trestle.

  1. Use mkdocs features to avoid having to specify the full nav: (awesome-pages, inferred structure from the directory tree). [issue created]
  2. Remove / refine the api docs (backing away from the earlier discussion) [TBD]
  3. Remove where possible html as it's harder to maintain [issue created]
  4. Look to make the website as DRY (e.g. abstracting links out etc [issue created]
  5. Introduce automated spell checking [ issue created]
  6. Minimise the website content for rendering [ ]
  7. Generate social previews for linking into linkedin / slack / teams / etc.
  8. Roll up into a single website for oscal compass [propose in the community org]
  9. Ensure all assets are in the website.
  10. Make the website index leverage the repo README.md explicitly.

Caveats / Assumptions

All of these need to be broken down. Some are quite a bit of effort.

Completion Criteria

Decisions are made (and issues opened) on the items above.

jpower432 commented 1 week ago

Number 2 and 8 need to be removed and considered separately:

2 is relevant to a community proposal and 8 should be considered at the org level