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

Document OSCAL Markdown #357

Closed
wendellpiez opened this issue May 16, 2019 · 6 comments
Closed

Document OSCAL Markdown #357

wendellpiez opened this issue May 16, 2019 · 6 comments
Assignees
Labels
Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@wendellpiez
Copy link
Contributor

wendellpiez commented May 16, 2019

User Story:

As an OSCAL User building interfaces, I may need to know how OSCAL's flavor of Markdown works and what it permits.

Goals:

  1. Update documentation for prose on pages.nist.gov.
    • Document use of OSCAL markdown syntax.
    • Show examples of prose in HTML and markdown based on OSCAL subsets
    • Create a table showing the HTML <> Markdown correspondences

Dependencies:

#343 must be finished so we have confidence that OSCAL Markdown works as currently designed.
#452 needs to be completed to ensure that the prose documentation page is in sync with the actual content generation behavior.
#451 needs to be fixed to ensure parameter insertion is handled as expected.

Acceptance Criteria

Users can find some help on using OSCAL Markdown on the Pages site.

@wendellpiez wendellpiez added this to the OSCAL 1.0 M1 milestone May 16, 2019
@david-waltermire david-waltermire added Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. labels May 16, 2019
@iMichaela
Copy link
Contributor

5/23/2019

#283 is nearly done so we can start working on this issue.

@david-waltermire
Copy link
Contributor

@wendellpiez It would be good to update the website prose page to include a mapping between HTML and Markdown features that are supported. This can be bumped to sprint 22, as it is not a blocker for the M1 release.

@david-waltermire
Copy link
Contributor

#452 needs to be completed before this is closed.

@david-waltermire
Copy link
Contributor

#451 needs to be fixed to ensure parameter insertion is handled as expected before this is closed.

@david-waltermire
Copy link
Contributor

david-waltermire commented Aug 15, 2019

This documentation is currently located in my branch. We can merge PR #449 once this is reviewed by the team and issues #451 and #452 are completed and verified.

@david-waltermire
Copy link
Contributor

This has been completed in PR #449.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Modeling Issues targeted at development of OSCAL formats Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Development

No branches or pull requests

3 participants