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

Automate the production of documentation on pages.nist.gov using metaschema and a CI/CD pipeline #274

Closed
akarmel opened this issue Dec 10, 2018 · 3 comments
Assignees
Labels
Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@akarmel
Copy link
Contributor

akarmel commented Dec 10, 2018

User Story:

As an OSCAL content consumer, I have access to documentation that is continuously up-to-date via an automated CI/CD pipeline.

Goals:

Develop a NIST CI/CD pipeline to automate the production of documentation on pages.nist.gov using the metaschema (@david-waltermire-nist)

Dependencies:

#273

Acceptance Criteria

  1. Documentation is automatically developed for pages.nist.gov using a NIST CI/CD pipleline from the OSCAL metaschema
@anweiss
Copy link
Contributor

anweiss commented Dec 11, 2018

This is dependent on support for some sort of "staging" endpoint on NIST Pages so documentation changes can be verified before pushing into prod ... i.e. https://pages-staging.nist.gov/OSCAL. According to the NIST Pages wiki, NIST Pages is based off of 18F's old pages-server project which had support for multi-branch publishing. However, @david-waltermire-nist would probably have to do some digging to see if this capability carried over into NIST Pages.

@wendellpiez
Copy link
Contributor

There is also a dependency here, or at least a relation to #273, the Issue regarding (re)structuring the Pages site -- when the pages site changes, the CI/CD will also have to.

@david-waltermire david-waltermire added Scope: Website Issues targeted at the OSCAL project website. Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. labels May 8, 2019
@david-waltermire david-waltermire added this to the OSCAL 1.0 M1 milestone May 29, 2019
@david-waltermire
Copy link
Contributor

This is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Development

No branches or pull requests

5 participants