Create tool to auto-populate documentation examples for decision point objects #364
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
environment
Project environment, deployment, CI, etc.
tools
Software Tools
Milestone
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](https://private-user-images.githubusercontent.com/2594236/279137788-d8e2827e-e189-49f8-a5aa-6eff309453e0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjU2ODA1NzEsIm5iZiI6MTcyNTY4MDI3MSwicGF0aCI6Ii8yNTk0MjM2LzI3OTEzNzc4OC1kOGUyODI3ZS1lMTg5LTQ5ZjgtYTVhYS02ZWZmMzA5NDUzZTAucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDkwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA5MDdUMDMzNzUxWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZDc2MGZiMDFmMDliOWZjZTdiZTUxZThjZjk2NDkwNDA5ZTEzNGMyNzQyMGY5ZGU1Nzk3MjY4Zjk2MGM2OWU4YSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.LvaGT4-kV60m_QsAaVjB1XRY3g9b-j6uCv9p6w1hm8U)
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.)
The text was updated successfully, but these errors were encountered: