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

feat(docs): howto use policy groups. #454

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

jvanz
Copy link
Member

@jvanz jvanz commented Sep 13, 2024

Description

Adds a new Howto page showing how to use the policy groups.

Fix #449

@jvanz jvanz requested a review from a team as a code owner September 13, 2024 19:29
Copy link

netlify bot commented Sep 13, 2024

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit 664ec40
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/66f2ab07e702e40008dbf893
😎 Deploy Preview https://deploy-preview-454--silly-bunny-8cedd0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

Some suggestions for your consideration.

docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
@flavio flavio self-assigned this Sep 16, 2024
@flavio
Copy link
Member

flavio commented Sep 20, 2024

I would even close this PR. It's basically a shorted version of the explanation page provided by #453

@jhkrug: what do you think, am I missing some nuance?

@jhkrug
Copy link
Contributor

jhkrug commented Sep 20, 2024

I thought they were quite similar, other than being in explanations and howtos. Maybe that's the distinction. Maybe another iteration of both, focusing on a better separation of the content into howto and explanation might be worth doing.

@jhkrug
Copy link
Contributor

jhkrug commented Sep 20, 2024

I think the whole first part could be replaced with:

Prior to working with Policy Groups, consult the explanation for them.

Then another look at what remains. The example is very similar to that in explanations. Say, something, like:

Using the example from [the explanation of Policy Groups](link to the example) use these commands to implement (or define) it.

Commands

Output.

That should do. The Context aware rules section is already covered in Context-Aware policies in the explanation (I think) so could be dispensed with.

What do you think?

@flavio flavio force-pushed the policy-group-howto branch 2 times, most recently from 3207357 to 3749fe5 Compare September 23, 2024 14:57
@flavio
Copy link
Member

flavio commented Sep 23, 2024

@jhkrug I've made the changes you described

Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

Two little suggestions to consider, but otherwise lgtm.

docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
docs/howtos/policy-groups.md Outdated Show resolved Hide resolved
Adds a new Howto page showing how to use the policy groups.

Signed-off-by: José Guilherme Vanz <[email protected]>
Co-authored-by: John Krug <[email protected]>
Co-authored-by: Flavio Castelli <[email protected]>
@flavio
Copy link
Member

flavio commented Sep 24, 2024

@jhkrug thanks for the last review

@flavio flavio merged commit a7e0058 into kubewarden:main Sep 24, 2024
2 checks passed
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.

PolicyGroup: add howto page
3 participants