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.

Sign up for GitHub

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 Readme #873

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Readme #873

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96f91e4
Update Readme.
rukletsov Nov 28, 2024
82cbd33
Try `---` for line separator.
rukletsov Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 12 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,28 +204,22 @@ The following are tutorials on KubeLinter written by users. If you have one that
* [How to add a new check in KubeLinter?](https://www.psaggu.com/upstream-contribution/2021/08/17/notes.html) by Priyanka Saggu.
* [Extending kube-linter To Build A Custom Template](https://github.com/garethahealy/kubelinter-extending-blog) by [Gareth Healy](https://github.com/garethahealy).

## Community

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

While this is somehow duplicated in the alpha release warning, I'd keep that line in the Community section.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agree, that's why there is the link to the guide in the community section below : ). Unless you insist on keeping the exact wording.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have no strong opinion there. The link in the rendered page is probably eye-catching enough.


As a reminder, all participation in the KubeLinter community is governed by our [code of conduct](./CODE_OF_CONDUCT.md).
## LICENSE

## WARNING: Alpha release
KubeLinter is licensed under the [Apache License 2.0](./LICENSE).

KubeLinter is at an early stage of development. 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).
## Community

## 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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should remove that and keep it GitHub centric.

Copy link
Member Author

Choose a reason for hiding this comment

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

You mean not mentioning slack at all? It's a common practice, for example, trivy, falco do that.


KubeLinter is licensed under the [Apache License 2.0](./LICENSE).
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).
Comment on lines +215 to +217
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to have a backward compatibility sub-section for that piece ?

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.


## StackRox
As a reminder, all participation in the KubeLinter community is governed by our
[code of conduct](./CODE_OF_CONDUCT.md).

KubeLinter is made with ❤️ by [StackRox](https://stackrox.com/).
---

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/).
Copy link
Contributor

Choose a reason for hiding this comment

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

The link here is wrong

Copy link
Member Author

Choose a reason for hiding this comment

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

Why? It redirects to the ACS page on Red Hat website.

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Loading