istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

Refactoring of istio concept page

Open aryan16 opened this issue 3 years ago • 13 comments

  1. Moved the authorization policy examples from the concept page to the operations/configuration /security/security-policy-examples

And to help us figure out who should review this PR, please put an X in all the areas that this PR affects.

  • [ ] Configuration Infrastructure
  • [ ] Docs
  • [ ] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Policies and Telemetry
  • [X] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure

aryan16 avatar Dec 06 '21 21:12 aryan16

😊 Welcome! This is either your first contribution to the Istio documentation repo, or it's been awhile since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, about our style guidelines, and about all the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built as a full copy of the istio.io website. You can find this preview by clicking on the Details link next to the deploy/netlify entry in the Status section of this page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the status section of the page. Click on the Details link to get a list of the problems with your PR. Fix those problems and push an update to your PR. This will automatically rerun the tests and hopefully this time everything will be perfect.

  • Once your changes are accepted and merged into the repository, they will initially show up on https://preliminary.istio.io. The changes will be published to https://istio.io the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Dec 06 '21 21:12 istio-policy-bot

Hi @aryan16. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

istio-testing avatar Dec 06 '21 21:12 istio-testing

@xulingqing could you please have a look in this pr.

aryan16 avatar Dec 06 '21 22:12 aryan16

Can you please not delete content in one commit and then add it back in a different commit? It makes it hard to track the changes. If content is moved, it will be easier to follow within a single commit.

justinpettit avatar Dec 07 '21 02:12 justinpettit

@justinpettit sorry I couldn't understand your comment properly. We want to have one single commit for the change right ? Right now we are following that only, the other commit which you see had few issues. I forgot to squash both the commits.

aryan16 avatar Dec 07 '21 17:12 aryan16

  1. Added a new section named Examples in references/configuration/security/Authorization Policy.

As noted above by Craig, this change will need to be done in the istio/api repo (https://github.com/istio/api/blob/master/security/v1beta1/authorization_policy.pb.html) and that will be pulled in (there is a daily job that runs that will pull the change). Note that the file is generated from https://github.com/istio/api/blob/master/security/v1beta1/authorization_policy.proto.

ericvn avatar Dec 08 '21 17:12 ericvn

noted.

aryan16 avatar Dec 08 '21 17:12 aryan16

I have moved some of the authorization examples to ops/configurations/security/security-policy-examples. I will add the tests once I get approval for this change. cc : @myidpt

aryan16 avatar Jan 06 '22 19:01 aryan16

@justinpettit sorry I couldn't understand your comment properly. We want to have one single commit for the change right ? Right now we are following that only, the other commit which you see had few issues. I forgot to squash both the commits.

I'm not saying that it should only be a single commit. I'm requesting that if you move text, please remove it from one file and add it to the other file in the same commit. If you are making changes that are logically separate (e.g., authn changes and authz changes), those should be in separate commits.

justinpettit avatar Jan 06 '22 20:01 justinpettit

@justinpettit sorry I couldn't understand your comment properly. We want to have one single commit for the change right ? Right now we are following that only, the other commit which you see had few issues. I forgot to squash both the commits.

I'm not saying that it should only be a single commit. I'm requesting that if you move text, please remove it from one file and add it to the other file in the same commit. If you are making changes that are logically separate (e.g., authn changes and authz changes), those should be in separate commits.

Understood!! In the new commit there are changes in 2 files. I removed content from one file and added the same content in the other file.

aryan16 avatar Jan 06 '22 21:01 aryan16

cc : @justinpettit

aryan16 avatar Jan 11 '22 19:01 aryan16

@aryan16: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

istio-testing avatar Dec 07 '22 22:12 istio-testing

@aryan16: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
doc.test.multicluster_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.multicluster
doc.test.profile_demo_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile_demo
doc.test.profile_none_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile_none
doc.test.profile_default_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile_default
doc.test.profile_minimal_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile_minimal
doc.test.profile-none_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile-none
doc.test.profile-minimal_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile-minimal
doc.test.profile-default_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile-default
doc.test.profile-demo_istio.io 80835f00a21e651acc1e921d8c861e4ee00b4bee link true /test doc.test.profile-demo

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

istio-testing avatar Jun 15 '23 17:06 istio-testing