-
Notifications
You must be signed in to change notification settings - Fork 181
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
Update OSCAL Catalog and Profile schema documentation #212
Comments
June 27, 2018 status: Standing by to help when needed. |
6/28/2018 StatusReviewed the user story to reflect the scenario discussed during the meeting. |
Many edits and improvements have been made in documentation in PR #201, but much remains to be done. In particular, while a better production framework is now in place for schema documentation, our editorial workflow is not; until it is, further work on this Issue is hindered. Since schema documents start with their metaschemas, editorial workflow for the documentation is tied to metaschema maintenance. However, an early goal could be to stabilize the catalog and profile metaschemas as soon as possible ("finishing" their inline documentation), permitting us to move the focus of effort to other useful kinds of docs (guides, tutorials etc). At time of writing, only the embedded docs are in place (started) but not finished. |
July 18 Status Update (Sprint 12 Acceptance Meeting)The issue was not assigned to any member of the team in Sprint 12 and we will push the issue to Sprint 13 |
8/9/18 Status
|
8/23/18 Status |
8/30/18 Status |
9/6/18 StatusShared documentation efforts with @david-waltermire-nist and received his input. Will incorporate it and work with @wendellpiez to set up a proper Github pipeline for production. |
9/13/18 StatusWorked with @wendellpiez to set up a Github pipeline for production of documentation. Working on incorporating input from @david-waltermire-nist and @wendellpiez on the catalog and profile schemas. |
9/26/2018@PCrayton received feedback from @wendellpiez and need just a little more time (low effort) in Sprint 14. |
10/4/2018This issue is related to #190 . @PCrayton Peter can wrap it by the end of next week. @david-waltermire-nist will review tomorrow the drafts. |
10/11/18 Status@PCrayton Will open a PR with the completed catalog and profile documentation in their respective metamodels. @wendellpiez and @david-waltermire-nist will review this. |
11/08/2018@david-waltermire-nist is reviewing the PR |
11/15/2018@david-waltermire-nist will accept PR #255 and we will plan new documentation activities to further improve the documentation in sprint 16. |
Need to review schema docs and make sure they are clear enough. Might be able to use some docs from PR #255. Make updates as needed. |
5/23/2019Needs update from @david-waltermire-nist . The issue will require coordination. |
This work is happening in #387. |
User Story:
As an OSCAL content consumer, I have clear, concise and descriptive documentation describing the Catalog and Profile layers of OSCAL.
Goals:
Dependencies:
None
Acceptance Criteria
The text was updated successfully, but these errors were encountered: