-
Notifications
You must be signed in to change notification settings - Fork 48
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
Update Limitations in README #398
Conversation
I wasn't sure how you'd like the wording / listing of supported platforms. |
Update the supported platforms to include RHEL8 as well. Support for this was added with theforeman#335 but this change didn't update the README as well.
README.md
Outdated
@@ -19,7 +19,7 @@ This module is designed to setup a full katello server, including candlepin, pul | |||
|
|||
## Limitations | |||
|
|||
* EL7 (RHEL7 / CentOS 7) | |||
* Supports EL7 (RHEL7 / CentOS 7) and EL8 (RHEL8 / CentOS 8) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about we refer users to operatingsystem_support
in metadata.json
for the exact OS support?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pro: one less thing to update whenever the supported OSes change (but how often does that really happen)
Cons: another click and another resource for the user to check.
Having it in the README has the upside that one can see right away what's what.
IMO I'd leave it there but obviously it's up to you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pro: one less thing to update whenever the supported OSes change (but how often does that really happen)
This is what I'm mostly after. As you can see, it doesn't happen enough that we tend to mess it up. Especially since not all modules have it in their README. However, our CI relies on metadata.json so that's guaranteed to be correct. So it would be my preference to refer users there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've just pushed another commit with an updated text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure how well links render on the forge but I'm ok with it.
Thanks! |
Ah I would've squashed those but thanks for doing it. |
Doesn't the forge display the metadata anyways? |
Yes, it renders the contents of the metadata so that it's visible there which platform to use. |
Update the supported platforms to include RHEL8 as well. Support for this was added with #335 but this change didn't update the README as well.
Closes #397