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

Propose ADR for Data Governance and Release Management for oscal-content #1947

Merged

Conversation

aj-stein-nist
Copy link
Contributor

@aj-stein-nist aj-stein-nist commented Oct 12, 2023

Committer Notes

This decision relates to future management of oscal-content#116.

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@aj-stein-nist aj-stein-nist requested a review from a team October 12, 2023 13:51
@aj-stein-nist aj-stein-nist changed the base branch from main to develop October 12, 2023 13:52
@aj-stein-nist aj-stein-nist force-pushed the 116-oscal-content-data-release-governance-adr branch 2 times, most recently from 9f52250 to f1c9c1a Compare October 13, 2023 04:48
@aj-stein-nist aj-stein-nist self-assigned this Oct 13, 2023
@aj-stein-nist aj-stein-nist force-pushed the 116-oscal-content-data-release-governance-adr branch 2 times, most recently from 77220dc to 97c601d Compare October 13, 2023 13:21
@aj-stein-nist aj-stein-nist marked this pull request as ready for review October 13, 2023 13:23
aj-stein-nist added a commit to usnistgov/oscal-content that referenced this pull request Oct 13, 2023
There are a number of changes we need to make to the structure and the
organization of example documents in the repository to improve the
maintainability and stability of building examples.

1. We need to remove now invalid docs, e.g. #208.
1. Remove JSON examples in src and convert them to XML first.
1. Remove old draft and FedRAMP directories, warning has been up for
long enough.
1. Remove old notes in src/examples/ssp/xml directory that are not
examples.
1. Relocate oscal submodule to build/oscal to match style of other
repositories in the project.
1. Update for OSCAL v1.1.1 release of models.
1. Align SP 800-53 Rev 5 catalog version with guidance in ADR in
usnistgov/OSCAL#1947, make version correctly 5.1.2.
1. Update last-modified, published, and version metadata as applicable.
1. Add jq and yq dependency install.
wendellpiez
wendellpiez previously approved these changes Oct 13, 2023
Copy link
Contributor

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We very much need this or something like it.

Bravo AJ for bringing this forward. As you know I don't agree 100% with every point - all the more reason to agree to this in principle, so we can act on it, making any subsequent refinements meaningful. I look forward to conversations.

Copy link
Contributor

@nikitawootten-nist nikitawootten-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall very much approve. I understand now the release approach you were referring to.

Blocking comment below.

decisions/0008-oscal-content-management.md Outdated Show resolved Hide resolved
@aj-stein-nist
Copy link
Contributor Author

I will merge this after usnistgov/oscal-content#204, since this will need to happen alongside that. Merging that PR means we are ready to roll. ⚡

iMichaela
iMichaela previously approved these changes Oct 13, 2023
aj-stein-nist added a commit to aj-stein-nist/oscal-content that referenced this pull request Oct 20, 2023
There are a number of changes we need to make to the structure and the
organization of example documents in the repository to improve the
maintainability and stability of building examples.

1. We need to remove now invalid docs, e.g. usnistgov/oscal-content#208.
1. Remove JSON examples in src and convert them to XML first.
1. Remove old draft and FedRAMP directories, warning has been up for
long enough.
1. Remove old notes in src/examples/ssp/xml directory that are not
examples.
1. Relocate oscal submodule to build/oscal to match style of other
repositories in the project.
1. Update for OSCAL v1.1.1 release of models.
1. Align SP 800-53 Rev 5 catalog version with guidance in ADR in
usnistgov/OSCAL#1947, make version correctly 5.1.2.
1. Update last-modified, published, and version metadata as applicable.
1. Add jq and yq dependency install.
aj-stein-nist added a commit to usnistgov/oscal-content that referenced this pull request Oct 24, 2023
There are a number of changes we need to make to the structure and the
organization of example documents in the repository to improve the
maintainability and stability of building examples.

1. We need to remove now invalid docs, e.g. #208.
1. Remove JSON examples in src and convert them to XML first.
1. Remove old draft and FedRAMP directories, warning has been up for
long enough.
1. Remove old notes in src/examples/ssp/xml directory that are not
examples.
1. Relocate oscal submodule to build/oscal to match style of other
repositories in the project.
1. Update for OSCAL v1.1.1 release of models.
1. Align SP 800-53 Rev 5 catalog version with guidance in ADR in
usnistgov/OSCAL#1947, make version correctly 5.1.2.
1. Update last-modified, published, and version metadata as applicable.
1. Add jq and yq dependency install.
aj-stein-nist added a commit to aj-stein-nist/oscal-content-forked that referenced this pull request Oct 27, 2023
There are a number of changes we need to make to the structure and the
organization of example documents in the repository to improve the
maintainability and stability of building examples.

1. We need to remove now invalid docs, e.g. usnistgov#208.
1. Remove JSON examples in src and convert them to XML first.
1. Remove old draft and FedRAMP directories, warning has been up for
long enough.
1. Remove old notes in src/examples/ssp/xml directory that are not
examples.
1. Relocate oscal submodule to build/oscal to match style of other
repositories in the project.
1. Update for OSCAL v1.1.1 release of models.
1. Align SP 800-53 Rev 5 catalog version with guidance in ADR in
usnistgov/OSCAL#1947, make version correctly 5.1.2.
1. Update last-modified, published, and version metadata as applicable.
1. Add jq and yq dependency install.
aj-stein-nist added a commit to aj-stein-nist/oscal-content-forked that referenced this pull request Oct 27, 2023
There are a number of changes we need to make to the structure and the
organization of example documents in the repository to improve the
maintainability and stability of building examples.

1. We need to remove now invalid docs, e.g. usnistgov#208.
1. Remove JSON examples in src and convert them to XML first.
1. Remove old draft and FedRAMP directories, warning has been up for
long enough.
1. Remove old notes in src/examples/ssp/xml directory that are not
examples.
1. Relocate oscal submodule to build/oscal to match style of other
repositories in the project.
1. Update for OSCAL v1.1.1 release of models.
1. Align SP 800-53 Rev 5 catalog version with guidance in ADR in
usnistgov/OSCAL#1947, make version correctly 5.1.2.
1. Update last-modified, published, and version metadata as applicable.
1. Add jq and yq dependency install.
@aj-stein-nist aj-stein-nist force-pushed the 116-oscal-content-data-release-governance-adr branch from 9531816 to d3a76c7 Compare November 9, 2023 22:34
@aj-stein-nist aj-stein-nist merged commit 1d8a9a0 into develop Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade GitHub CI/CD Workflows to Current Stable Version
4 participants