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

toolkit: supported platforms: note that things may work on other/newer distros #159

Merged
merged 1 commit into from
Feb 19, 2025

Conversation

jgehrcke
Copy link
Contributor

I was reading through the discussion in #62 and found it very tangible. Instead of iterating on the PR I thought I create a new one with my proposal to address some of the points discussed there.

I very much agree with @elezar that we need a note about those distributions that are not listed in that table, and that we want to invite people to just try things out. This is the main part of this patch.

Additional changes:

  • Centos -> CentOS
  • Instead of loading lots of meaning into a single word: "supported" vs "qualified" I propose using slightly more exhaustive wording: "qualification-tested and expected to work on these platforms"
  • We did use footnotes, and I have changed one note about Tegra into a footnote.

@jgehrcke jgehrcke force-pushed the jp/tk-supported-platforms branch from 6a837d6 to 27bf20a Compare February 13, 2025 13:15
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.

I think I'm happy with the changes.

@a-mccarthy any further comments?

| Ubuntu 24.04 | X | | X |


Note:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe lets put this in its own section? or as some paragraphs after the table. Otherwise the footnotes get pushed down further and we have a bit of note inception going on, notes within notes.

Maybe something like "Using unsupported distros" or "Distribution testing" or "Additional distros" for a section heading. Then we can go into details on the qualification testing done and your note on using unsupported distros how to give us feedback?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe lets put this in its own section? or as some paragraphs after the table.

Yes, I like that you say this. Thought about it too, was looking for feedback about this in particular.

I will add sub sections, one about reporting issues in general, and one about "Other Linux distributions".

The `arm64` / `aarch64` architecture includes support for Tegra-based systems.

1. For Amazon Linux 2023 on Arm64, a `g5g.2xlarge` Amazon EC2 instance was used for validation.
Releases are qualification-tested and expected to work on these platforms:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure what qualification-testing means. Is it generic enough that readers would know what it means? Are there qualifications that we test that are specific to the software that we can link to?

I'd be a little cautious with removing the word "support" entirely here. B/c I don't want this to read like "we support everything, everywhere, all the time". Is there an SLA on support and what the community can reasonably expect in terms of getting questions answered for unsupported use cases?

Copy link
Contributor Author

@jgehrcke jgehrcke Feb 13, 2025

Choose a reason for hiding this comment

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

I'm not sure what qualification-testing means.

Qualification-testing in my experience in software engineering typically refers to a quality assurance stage as part of a release process, trying to make (pretty damn) sure that things really work (this is testing done in addition to, say, CI tests).

Other than that, I allow myself to make a bit of a joke here and refer to NASA:

image

I think you inspire me to simplify. I will remove the "qualification-". Simplicity wins, so I will push a commit changing this to:

Releases are tested and expected to work on these platforms

@a-mccarthy
Copy link
Collaborator

@jgehrcke thanks for the PR! I think its great to encourage the community to try out stuff and give us feedback. It feels like 2 separate concerns here though.

  1. List what is supported and what users can expect to be supported to get questions answered if they run into issues
  2. Letting folks know a bit about the testing and that things should work on other distros if they want to experiment or have a need to use something not on the official list

I added a few comments about this inline as well, but I'm thinking it might be best to have your additions in their own section. Just my 2 cents, I'm not overly familiar with the testing and support matrix in depth though, so i might not be thinking about things the same as you all :)

@jgehrcke
Copy link
Contributor Author

I pushed an update. This is how this currently renders in my VSCode:

image

Copy link

Documentation preview

https://nvidia.github.io/cloud-native-docs/review/pr-159

@jgehrcke
Copy link
Contributor Author

conflicting with #152

Notes:

- picking up the discussion from NVIDIA#62
- pull superscript into table heading, rewarp, renumber
- Centos -> CentOS
- Change heading: supported platforms -> platform support
  (because this page also talks about other distros)
- Remove "Linux Distributions" heading because there is no other category
- Review feedback: move bullet notes into subsections, one for each

Signed-off-by: Dr. Jan-Philip Gehrcke <[email protected]>
@jgehrcke jgehrcke force-pushed the jp/tk-supported-platforms branch from 4dc6017 to 372177e Compare February 18, 2025 10:46
@jgehrcke
Copy link
Contributor Author

jgehrcke commented Feb 18, 2025

Merge conflict resolved, squashed into single commit, worked on commit msg (trying to summarize changes).

@jgehrcke
Copy link
Contributor Author

Going ahead here, we can always discuss and iterate more post-merge. Thanks for feedback, everyone.

@jgehrcke jgehrcke merged commit 3185f07 into NVIDIA:main Feb 19, 2025
2 checks passed
@jgehrcke jgehrcke mentioned this pull request Feb 19, 2025
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.

None yet

3 participants