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

Jump to bottom

docs: [Policy Assistant] walkthrough demo with use cases and example files #269

Merged
merged 3 commits into from
Nov 14, 2024
Merged

docs: [Policy Assistant] walkthrough demo with use cases and example files #269

merged 3 commits into from
Nov 14, 2024

Conversation

huntergregory
Copy link
Contributor

Walkthrough mode has a lot of great functionality that ought to be documented with example YAML/JSON files.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 11, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: huntergregory

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 11, 2024
@netlify Netlify
Copy link

netlify bot commented Nov 11, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-network-policy-api ready!

Name Link
🔨 Latest commit 47307fc
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-network-policy-api/deploys/673569d1a063f00008a2b3f3
😎 Deploy Preview https://deploy-preview-269--kubernetes-sigs-network-policy-api.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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 11, 2024
@huntergregory huntergregory force-pushed the example-walkthrough branch 3 times, most recently from 5b43c95 to 61dc8e6 Compare November 11, 2024 22:24
@huntergregory
Copy link
Contributor Author

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Nov 11, 2024
@huntergregory huntergregory mentioned this pull request Nov 11, 2024
Merged
tssurya
tssurya reviewed Nov 13, 2024
View reviewed changes
cmd/policy-assistant/examples/demos/walkthrough/README.md Outdated
To try for yourself:

1. Download `policy-assistant` via the [Quick Install](../../../README.md#quick-install) guide.
1. Leverage the JSON/YAML files in this folder.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: bullet points here are all 1?
also how exactly would they leverage these yamls/json.. ? is it by providing them in the path ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

#269 (comment)

also md let's you specify 1's instead of using 1,2,3, 😜

@huntergregory
Copy link
Contributor Author

thanks for the review @tssurya . Your review made me realize this wasn't the clearest demo. I redid it to have a better narrative

@tssurya
Copy link
Contributor

tssurya commented Nov 14, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2024
@k8s-ci-robot k8s-ci-robot merged commit 92c9198 into kubernetes-sigs:main Nov 14, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tssurya tssurya tssurya left review comments

@Dyanngg Dyanngg Awaiting requested review from Dyanngg

@mattfenwick mattfenwick Awaiting requested review from mattfenwick

Assignees

@tssurya tssurya

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@huntergregory @k8s-ci-robot @tssurya