Update Readme #873
Update Readme #873
Conversation
|
|
||
| If you would like to engage with the KubeLinter community, including maintainers and other users, you can join the Slack workspace [here](https://join.slack.com/t/kube-linter/shared_invite/zt-kla9qvyo-Tk~wynTSbr9EE3AjHcv4BQ). | ||
|
|
||
| To contribute, check out our [contributing guide](./CONTRIBUTING.md). |
There was a problem hiding this comment.
While this is somehow duplicated in the alpha release warning, I'd keep that line in the Community section.
There was a problem hiding this comment.
Agree, that's why there is the link to the guide in the community section below : ). Unless you insist on keeping the exact wording.
There was a problem hiding this comment.
I have no strong opinion there. The link in the rendered page is probably eye-catching enough.
| There may be breaking changes in the future to the command usage, flags, and configuration | ||
| file formats. However, we encourage you to use KubeLinter to test your environment YAML | ||
| files, see what breaks, and [contribute](./CONTRIBUTING.md). |
There was a problem hiding this comment.
Would it make sense to have a backward compatibility sub-section for that piece ?
There was a problem hiding this comment.
Good thought. I guess at this point we don't really have clear backward compatibility guidelines nor guarantees, so maybe it's a bit too early to pull this out into a separate section? No strong opinion here, open for suggestions.
There was a problem hiding this comment.
That was food for thought. Adding a dedicated section will also make the bottom block bigger and might make the message less catchy. Things can be left in their current state for now.
| If you're interested in KubeLinter, or in any of the other cool things we do, please know that we're hiring! | ||
| Check out our [open positions](https://www.stackrox.com/job-board/). We'd love to hear from you! | ||
| KubeLinter is created with ❤️ by [StackRox](https://www.stackrox.io/) and is now powered | ||
| by [Red Hat](https://stackrox.com/). |
There was a problem hiding this comment.
Why? It redirects to the ACS page on Red Hat website.
There was a problem hiding this comment.
I find it awkward to have the name of a company and the (hover) link pointing at a different address.
The current recommended corporate security practices (like phishing prevention) suggest not to click links where name and associated link address don't match.
|
|
||
| ## LICENSE | ||
| If you would like to engage with the KubeLinter community, including maintainers and other users, you can join the Slack workspace [here](https://join.slack.com/t/kube-linter/shared_invite/zt-kla9qvyo-Tk~wynTSbr9EE3AjHcv4BQ). |
There was a problem hiding this comment.
Maybe we should remove that and keep it GitHub centric.
There was a problem hiding this comment.
I know but who is there to answer?
|
@sourcery-ai review |
Reviewer's Guide by SourceryThis pull request updates the README.md file to reflect the current state of the KubeLinter project. It updates the StackRox URL, adds Red Hat as a sponsor, and reorganizes the sections for better readability. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @rukletsov - I've reviewed your changes - here's some feedback:
Overall Comments:
- It looks like the 'WARNING: Alpha release' section was removed - is KubeLinter no longer in Alpha?
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| If you're interested in KubeLinter, or in any of the other cool things we do, please know that we're hiring! | ||
| Check out our [open positions](https://www.stackrox.com/job-board/). We'd love to hear from you! | ||
| KubeLinter is created with ❤️ by [StackRox](https://www.stackrox.io/) and is now powered | ||
| by [Red Hat](https://stackrox.com/). |
There was a problem hiding this comment.
issue (typo): Incorrect StackRox link.
The link to StackRox should be https://www.stackrox.io/. Also, the Red Hat link appears to be the same as the old StackRox link - is this correct?
| As a reminder, all participation in the KubeLinter community is governed by our | ||
| [code of conduct](./CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
nitpick (typo): Missing period.
Add a period after the link to the Code of Conduct.
Suggested implementation:
As a reminder, all participation in the KubeLinter community is governed by our
[code of conduct](./CODE_OF_CONDUCT.md).
Insert the period at the end of the line containing the Code of Conduct link. If your file uses a specific line ending or context structure, please adjust the change accordingly.
Summary by Sourcery
Update the README to reflect the project's current state, including moving the license information higher in the document, updating the StackRox link to Red Hat, and rephrasing the alpha release warning.
Chores: