Skip to content

Remove references to specific OSCAL releases inREADME.md#1261

Merged
david-waltermire merged 3 commits intousnistgov:mainfrom
guyzyl:update-readme-oscal-version
May 12, 2022
Merged

Remove references to specific OSCAL releases inREADME.md#1261
david-waltermire merged 3 commits intousnistgov:mainfrom
guyzyl:update-readme-oscal-version

Conversation

@guyzyl
Copy link
Copy Markdown
Contributor

@guyzyl guyzyl commented May 12, 2022

Committer Notes

The project's main README.md file notes the latest OSCAL version that was released (currently 1.0.1). This PR removes those references so the README.md file doesn't have to be updated with every new OSCAL release.

Additionally, the PR fixes some broken links in the README.md.

All Submissions:

Copy link
Copy Markdown
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

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

Definitely love the continued guyzyl contributions!

On a critical note to Dave and the team, shouldn't we just point to the releases page without explicitly changing the current release note here? Seems like something we will continue to miss once in a while, without the help of great community members of course. :-)

@guyzyl
Copy link
Copy Markdown
Contributor Author

guyzyl commented May 12, 2022

@aj-stein-nist I agree, it'd be better not to have to update the README.md for every release.
Should I update the PR?

@aj-stein-nist
Copy link
Copy Markdown
Contributor

@aj-stein-nist I agree, it'd be better not to have to update the README.md for every release. Should I update the PR?

I'll ask the rest of the team when we catch up on issues later this morning and let you know, sound good?

@guyzyl
Copy link
Copy Markdown
Contributor Author

guyzyl commented May 12, 2022

@aj-stein-nist yep, let me know once a decision has been made.

Copy link
Copy Markdown
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

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

I got confirmation, see feedback reiterating what we discussed earlier in the day. Thanks!

@guyzyl guyzyl changed the title Update OSCAL version noted inREADME.md to latest Remove references to specific OSCAL releases inREADME.md May 12, 2022
Copy link
Copy Markdown
Contributor

@david-waltermire david-waltermire left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks!

@david-waltermire david-waltermire merged commit bf6ffac into usnistgov:main May 12, 2022
aj-stein-nist pushed a commit to aj-stein-nist/OSCAL-forked that referenced this pull request May 16, 2022
…#1261)

* Update latest OSCAL version noted in `README.md`
* Remove references to specific OSCAL releases
* Fix broken links
Rene2mt pushed a commit to Rene2mt/OSCAL that referenced this pull request May 17, 2022
…#1261)

* Update latest OSCAL version noted in `README.md`
* Remove references to specific OSCAL releases
* Fix broken links
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.

3 participants