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

docs: expansion docs rewrite #2707

Merged
merged 7 commits into from
May 3, 2023

Conversation

acpana
Copy link
Contributor

@acpana acpana commented Apr 18, 2023

Been brainstorming how to rewrite some of the expansion docs. Here's a small stab at it. I encourage y'all to use the suggestion feature here.

Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
acpana and others added 2 commits April 18, 2023 12:31
Co-authored-by: Steven E. Harris <seh@panix.com>
Signed-off-by: alex <8968914+acpana@users.noreply.github.com>
Co-authored-by: Steven E. Harris <seh@panix.com>
Signed-off-by: alex <8968914+acpana@users.noreply.github.com>
@acpana
Copy link
Contributor Author

acpana commented Apr 18, 2023

@seh thanks for the suggestions 💯

I'm curious if you are using the ExpansionTemplate feature. If so, is there anything else you'd like to see in the docs or do you have any other input that would make the docs more effective?

We want to make sure this is as easy to use and clear to understand for folks as possible

@seh
Copy link
Contributor

seh commented Apr 18, 2023

I'm curious if you are using the ExpansionTemplate feature. If so, is there anything else you'd like to see in the docs or do you have any other input that would make the docs more effective?

I confess that I hadn't even heard of this feature until I was trying to updated my generated CUE definitions for the Mutations API, per cue-lang/cue#2046 (comment). I then started reading the pending and recent Gatekeeper commits, and found this proposal.

It took me a few passes over the documentation to realize that this is similar to Kyverno's "auto-gen rules." I have experience fighting against those rules, but I haven't tried Gatekeeper's feature to see how it compares.

@davis-haba
Copy link
Contributor

davis-haba commented Apr 20, 2023

couple comments, but overall looks greatly improved! thanks for looking at this

Copy link
Contributor

@maxsmythe maxsmythe left a comment

Choose a reason for hiding this comment

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

Looking good!

website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
website/docs/expansion.md Outdated Show resolved Hide resolved
see the [Match Source](#match-source) section below, or to see a working example,
see the [Example](#example) section.

#### Enforcement Points
Copy link
Contributor

Choose a reason for hiding this comment

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

The title doesn't match the content.

"Unknown Data"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed the title

Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
@acpana
Copy link
Contributor Author

acpana commented Apr 25, 2023

thanks for your feedback before folks 💯

@davis-haba @maxsmythe PTAL 🥇

Copy link
Contributor

@maxsmythe maxsmythe left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this!

@acpana acpana requested review from sozercan and ritazh May 1, 2023 22:13
Copy link
Member

@ritazh ritazh left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks!

@davis-haba
Copy link
Contributor

LGTM! Sorry, I thought I commented last week but apparently not 🤷

@acpana acpana merged commit 36130ee into open-policy-agent:master May 3, 2023
@acpana acpana deleted the acpana/et-docs-more branch May 3, 2023 00:15
anlandu pushed a commit to anlandu/gatekeeper that referenced this pull request May 19, 2023
Signed-off-by: Alex Pana <8968914+acpana@users.noreply.github.com>
Signed-off-by: alex <8968914+acpana@users.noreply.github.com>
Co-authored-by: Steven E. Harris <seh@panix.com>
Signed-off-by: Anlan Du <adu47249@gmail.com>
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.

5 participants