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

[EPIC] Write OSCAL content creation tutorials #599

Closed
6 tasks
david-waltermire opened this issue Jan 9, 2020 · 1 comment
Closed
6 tasks

[EPIC] Write OSCAL content creation tutorials #599

david-waltermire opened this issue Jan 9, 2020 · 1 comment
Labels
enhancement Epic A collection of issues to be worked on over a series of sprints Scope: Documentation This issue relates to OSCAL documentation. User Story

Comments

@david-waltermire
Copy link
Contributor

david-waltermire commented Jan 9, 2020

User Story:

As an OSCAL content creator, I need to understand how to create OSCAL content by hand. This will help me create content until suitable content creation tools exist for me to use.

Goals:

Create a series of tutorials covering content creation topics.

Each tutorial will need to provide:

  • An explanation of what prerequisite knowledge the reader must have.
  • Information about any tools needed for the tutorial, including how to download, install, and use the tool.
  • A brief discussion of the OSCAL concepts, including pointers to the OSCAL documentation pages for more information.
  • A step-by-step walkthrough explaining how to create the different parts of the OSCAL content. Each step should include examples in XML, JSON, and YAML.
  • A full completed example at the end of the tutorial in XML, JSON, and YAML.

Initial tutorials will include:

Other tutorials may address #567, #572.

Dependencies:

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.
@david-waltermire david-waltermire added enhancement User Story Epic A collection of issues to be worked on over a series of sprints Scope: Documentation This issue relates to OSCAL documentation. labels Jan 9, 2020
@david-waltermire david-waltermire added this to the OSCAL 1.0 Milestone 3 milestone Jan 9, 2020
@david-waltermire
Copy link
Contributor Author

Issue #293 previously identified this work. Closing the old one in favor of this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Epic A collection of issues to be worked on over a series of sprints Scope: Documentation This issue relates to OSCAL documentation. User Story
Projects
None yet
Development

No branches or pull requests

1 participant