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

Create tool to auto-populate documentation examples for decision point objects #364

Closed
ahouseholder opened this issue Oct 30, 2023 · 0 comments · Fixed by #370
Closed

Create tool to auto-populate documentation examples for decision point objects #364

ahouseholder opened this issue Oct 30, 2023 · 0 comments · Fixed by #370
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request environment Project environment, deployment, CI, etc. tools Software Tools
Milestone

Comments

@ahouseholder
Copy link
Contributor

This is (I think) the last item to cover the changes that were all bunched up in #339.

This issue is to create a tool that can automatically populate example text (markdown), json, and possibly python examples based on python SsvcDecisionPoint objects. The target is to be able to automatically generate these as separate files that can be included into the info box at the top of the page for a decision point, as for example in:

https://certcc.github.io/SSVC-staging/reference/decision_points/automatable/

(screenshot follows)
Screenshot 2023-10-30 at 1 01 18 PM

The resulting output should be clearly delineated as generated content to reduce the chance of misplaced effort in manually editing docs that will be overwritten by a future build process. (I.e., use a specific directory name and/or comments in the files to indicate that they are generated files and should not be edited.)

@ahouseholder ahouseholder self-assigned this Oct 30, 2023
@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request tools Software Tools environment Project environment, deployment, CI, etc. labels Oct 30, 2023
@ahouseholder ahouseholder added this to the SSVC 2023Q4 milestone Oct 30, 2023
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 enhancement New feature or request environment Project environment, deployment, CI, etc. tools Software Tools
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant