OSCAL
OSCAL copied to clipboard
Add OSCAL Catalog and Profile Tutorials to Website
User Story:
As an OSCAL content creator, I need a set of tutorials that provide basic instruction on creating an OSCAL Catalog or Profile. I should be able to find these tutorials on the OSCAL website..
Goals:
This is a continuation of the work completed in issues #592 and #593.
The following work needs to be completed:
- Website modificiations:
- The tutorials must be accessible using in "Tutorial" link in the main navigation.
- The tutorial text needs to be edited to integrate code examples with the syntax highlighting provided by Hugo.
- JSON and YAML examples need to be added to the existing XML examples.
- A Pull Request is submitted containing the above changes.
Dependencies:
None.
Acceptance Criteria
- [ ] All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
- [ ] A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
- [ ] The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
This is being worked in PR #648.
At this point, the tutorials have been migrated into the website content folder, the main navigation is setup. Almost done adding JSON and YAML to the catalog tutorial
As Dave has rolled of the project, I will re-assign this to myself in the interim until I can update it.
We are nearing the end of Sprint 64. I will leave this open for Sprint 65 and pick it up if there is no volunteer, we can pick it up in the second half of that sprint.
It seems from the state of the catalog tutorial, the JSON and YAML examples for the catalog tutorial are finished, and the remaining work on this issue to create a basic profile tutorial.
I can try and pick this up this sprint.
Observed AC:
- [ ] Minor fixes to the catalog tutorial (malformed JSON in this section)
- [ ] Create a profile tutorial modeled after the catalog tutorial that:
- [ ] Describes the OSCAL profile model, the act of profile resolution, and links to the relevant model docs and specs.
- [ ] Builds a profile from scratch
- [ ] Shows the resolved profile for each step
@nikitawootten-nist, @Arminta-Jenkins-NIST asked about this issue and she is interested in this as well. Can you two work together when you have a chance?
Team notified each other during standup today this likely will not get done before end of sprint today, will potentially opt to move forward and complete in Sprint 66.
@nikitawootten-nist can you please provide a status update for this on Monday so I can adjust for sprint wrap-up and reporting? Thank you!
can you please provide a status update for this on Monday so I can adjust for sprint wrap-up and reporting? Thank you!
Hi all, the profile tutorial is in the process of being rewritten based on an example profile that builds off of the existing catalog tutorial. The progress of this issue can be found here: https://github.com/usnistgov/OSCAL/pull/1747.
As of now, all sections of the tutorial have been written except for sections pertaining to the "import" and "merge" phases, which is currently in progress.
@Arminta-Jenkins-NIST, I was under the impression you were working on part of this and we can review the work and resolve. Can we get a status update please?
Judging from what I had read and discussed with some of you yesterday, it seems this needs to be moved into Sprint 68.