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

Various website enhancements #1677

Open
6 tasks
butler54 opened this issue Aug 30, 2024 · 1 comment
Open
6 tasks

Various website enhancements #1677

butler54 opened this issue Aug 30, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation Epic

Comments

@butler54
Copy link
Collaborator

butler54 commented Aug 30, 2024

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.

@butler54 butler54 added the documentation Improvements or additions to documentation label Aug 30, 2024
@butler54 butler54 assigned butler54 and unassigned butler54 Aug 30, 2024
@jpower432
Copy link
Member

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

@jpower432 jpower432 added the Epic label Sep 4, 2024
@butler54 butler54 self-assigned this Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Epic
Projects
Status: Ready
Development

No branches or pull requests

2 participants