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

Minor improvements in grammar and clarity #1831

Merged
merged 4 commits into from
Jul 7, 2023

Conversation

galtm
Copy link
Contributor

@galtm galtm commented Jun 30, 2023

Committer Notes

While reading this readme document, I found a few ways to improve it. I'm not sure I am using the correct branch for this PR, so let me know if I should use a different branch instead.

Closes #1822.
Closes #1826.
Closes #1829.
Closes #1833.
Closes #1834.
Closes #1835.
Closes #1836.
Closes #1837.
Closes #1838.
Closes #1840.

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? N/A
  • Have you included examples of how to use your new feature(s)? N/A
  • 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. N/A

src/metaschema/readme.md Outdated Show resolved Hide resolved
Copy link
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.

Thank you so much for looking at this @galtm and bringing it to our attention. I had not read this page in a long while. I appreciate your copy editing contributions and want to keep the first part, but can we remove the rest of the document? A lot of it is useful, but reudnant with the MIMF site, so I would rather just point them to the source and reduce churn on docs (for instance, we don't have only five models anymore in current releases, but Metaschema changes will be document on their site, I'd rather focus on working with the relevant primary copy of that information. 😄)

src/metaschema/readme.md Outdated Show resolved Hide resolved
src/metaschema/readme.md Outdated Show resolved Hide resolved
src/metaschema/readme.md Outdated Show resolved Hide resolved
@aj-stein-nist
Copy link
Contributor

Also note for the me and the rest of the team if they see this PR: it may need amendment when the upcoming release-1.0 branch is pushed into main to "sync" them and I will help adjust this PR accordingly for a potential merge conflict iff necessary, thanks again!

@galtm
Copy link
Contributor Author

galtm commented Jun 30, 2023

Now that the 2nd commit replaces much of the content with a link, does this PR now address #1830 ?

aj-stein-nist
aj-stein-nist previously approved these changes Jun 30, 2023
Copy link
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.

Looks good and thanks for this, @galtm. Need to do some bookkeeping before merge. I welcome review from other team members as well.

src/metaschema/readme.md Outdated Show resolved Hide resolved
@aj-stein-nist aj-stein-nist merged commit 5e9e348 into usnistgov:main Jul 7, 2023
@galtm galtm deleted the patch-3 branch July 10, 2023 12:24
@aj-stein-nist aj-stein-nist added this to the v1.1.0 milestone Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment