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

README fixes/enhancements #832

Merged
merged 27 commits into from
Aug 23, 2024
Merged

Conversation

chipzoller
Copy link
Contributor

@chipzoller chipzoller commented Jul 17, 2024

This PR:

  • Adds yaml fencing to code blocks.
  • Fixes some misspelling and Markdown linting issues.
  • Adds a note on MPS experimental status.
  • Adds a paragraph on sharing scope.
  • Converts some lines to GitHub Alerts Markdown syntax.
  • Makes a correction regarding how GFD comes packaged (i.e., no longer as a subchart as of v0.15.0).

Signed-off-by: Chip Zoller <[email protected]>
Signed-off-by: Chip Zoller <[email protected]>
Signed-off-by: Chip Zoller <[email protected]>
Signed-off-by: Chip Zoller <[email protected]>
@elezar elezar self-assigned this Jul 17, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Chip Zoller <[email protected]>
Signed-off-by: Chip Zoller <[email protected]>
@chipzoller chipzoller requested a review from elezar July 17, 2024 14:16
Signed-off-by: chipzoller <[email protected]>
Copy link
Collaborator

@ArangoGutierrez ArangoGutierrez left a comment

Choose a reason for hiding this comment

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

lgtm

@chipzoller
Copy link
Contributor Author

Thanks for the review. This look good to go?

@chipzoller
Copy link
Contributor Author

Since this is still open, I added a short paragraph about the scope of sharing.

@klueska
Copy link
Contributor

klueska commented Aug 5, 2024

Changes seem reasonable to me, I'll leave it to @elezar for final approval

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@elezar elezar left a comment

Choose a reason for hiding this comment

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

Thanks @chipzoller.

I think these change look good from a content perspective. Definitely some good additions and clarifications.

I would like for the types on the code blocks to be used consistently though and would like to better understand the TOC changes.

@chipzoller chipzoller requested a review from elezar August 8, 2024 15:33
@chipzoller
Copy link
Contributor Author

@elezar anything else here or can we merge?

@chipzoller
Copy link
Contributor Author

Bump

@chipzoller
Copy link
Contributor Author

Folks, this simple readme PR has been outstanding for a month. What more can I do to help update your documentation here?

@mikemckiernan
Copy link
Member

Folks, this simple readme PR has been outstanding for a month. What more can I do to help update your documentation here?

Thanks for all your time and help. If you don't object to my suggs and requests, but don't have time, PLMK if it's OK to push a commit.

@chipzoller
Copy link
Contributor Author

Sure, and I'm glad to implement any suggestions as well.

Copy link
Member

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

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

Thanks again for your willingness to pitch in.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: chipzoller <[email protected]>
@chipzoller
Copy link
Contributor Author

Done

Copy link
Member

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

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

Thanks again for the assist.

@mikemckiernan
Copy link
Member

We'll look at this after the lint CI job is revised.

@chipzoller
Copy link
Contributor Author

Merged main so CI can probably be kicked off again assuming it pulled in those fixes.

@mikemckiernan mikemckiernan merged commit 63ef521 into NVIDIA:main Aug 23, 2024
8 checks passed
@chipzoller chipzoller deleted the cz-readme-fixes branch August 23, 2024 14:03
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.

5 participants