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

Refine content to create Pages in GitHub #129

Closed
kscarf1 opened this issue Mar 15, 2018 · 8 comments
Closed

Refine content to create Pages in GitHub #129

kscarf1 opened this issue Mar 15, 2018 · 8 comments

Comments

@kscarf1
Copy link
Contributor

kscarf1 commented Mar 15, 2018

Work to do once we have better documentation:

  1. Create a branch named "nist-pages".
  2. Move content to that branch.
  3. Setup a webhook to publish to: https://pages.nist.gov/deploy

Goals:

Provide a useful collection of OSCAL documentation on https://pages.nist.gov that: 1) explains the concepts comprising OSCAL, 2) provides documentation on how to use OSCAL, and 3) decribes how to create and use the example catalogs and profiles we have created, and 4) describes how to create new content using OSCAL.

Acceptance Criteria:

  • Verify that the site is deployed to https://pages.nist.gov
  • Validate that the site provides documentation that addresses the goals above.

Was originally issue #30

@kscarf1
Copy link
Contributor Author

kscarf1 commented Mar 15, 2018

3/15/2018 - Sprint 9 Progress Notes

  • No progress this week - should have some progress to report next week.

@akarmel
Copy link
Contributor

akarmel commented Mar 22, 2018

3/22/2018 - Sprint 9 Progress Notes

  • Need Andrew's input to determine next steps (Karen will reach out to Andrew)
    • Will we be pulling docs from the "nist-pages" branch?, etc.
    • How will the workflow work?

@kscarf1
Copy link
Contributor Author

kscarf1 commented Mar 29, 2018

Documentation on prep for pages.nist.gov publishing is posted at: https://github.com/usnistgov/pages-root/wiki/Configuring-your-repo-for-publishing-on-pages.nist.gov

@kscarf1
Copy link
Contributor Author

kscarf1 commented Mar 29, 2018

Wendell, Dave, Andrew, and I met to discuss documentation workflow. When we are ready to generate content for pages.nist.gov, it will take just a few minutes to run scripts that automatically generate the page content without actually publishing it to pages.nist.gov. This will allow our team to review it and refine it before publishing the final version to pages.nist.gov. The nist-pages branch and other needed parts of this will automatically be created by the scripts. Andrew has demonstrated how this works at https://github.com/anweiss/OSCAL/tree/nist-pages.

Everything is ready for us to create pages.nist.gov pages. I need to first complete the content development in issues #110, #127, and #130.

@akarmel
Copy link
Contributor

akarmel commented Mar 29, 2018

3/29/2018 - Sprint 9 Progress Notes

  • See Karen's progress note above
  • Just need to have content ready to run through this documentation workflow
  • Intent is to setup a web hook to automate publishing at the end of this sprint

@kscarf1
Copy link
Contributor Author

kscarf1 commented Apr 4, 2018

I have completed drafts of all content needed for pages.nist.gov release during Sprint 9. I have asked Andrew to convert the source documents into a Slate format for core team review.

@akarmel
Copy link
Contributor

akarmel commented Apr 5, 2018

4/5/2018 - Sprint 9 Progress Notes

  • See Karen's progress note above
  • This is the final component that needs to be completed by Thursday, 4/12
  • Two meetings scheduled for next week to both review documentation and to publish pages.nist.gov/OSCAL at the end of the Sprint.

@david-waltermire david-waltermire added this to the OSCAL 1.0 M1 milestone Apr 6, 2018
@akarmel
Copy link
Contributor

akarmel commented Apr 12, 2018

4/12/2018 - Sprint 9 Acceptance

  • Publishing pages.nist.gov/OSCAL
  • Closing issue.

@akarmel akarmel closed this as completed Apr 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants