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

Ambient User Guide - L7 Waypoint Proxy Layer Sub Guide

Open fykaa opened this issue 1 year ago • 12 comments

This pull request addresses the issue of providing a usage guide for ambient mesh. It includes a sub-guide for the user guide on the L7 waypoint proxy. Please review and provide suggestions.

Reference:

  • https://github.com/istio/istio.io/issues/13481

And to help us figure out who should review this PR

  • [x] Ambient
  • [x] Docs
  • [x] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Extensions and Telemetry
  • [ ] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure

fykaa avatar Sep 29 '23 18:09 fykaa

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

  • You can learn about how we write and maintain documentation, our style guidelines, and 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 with 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, sanitize the Markdown, ensure all hyperlinks point to a valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the lint_istio.io entry in the status section. Click on the Details link to get a list of the problems with your PR. Fix those problems and push an update; this will automatically re-run the tests. 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). To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Sep 29 '23 18:09 istio-policy-bot

Hi @fykaa. 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 Sep 29 '23 18:09 istio-testing

@srampal @linsun @AndreaM12345

fykaa avatar Sep 29 '23 18:09 fykaa

@fykaa thanks for updating the PR - I will review it today.

In the meanwhile, can you get lint fixed? details: https://storage.googleapis.com/istio-prow/pr-logs/pull/istio_istio.io/13954/lint_istio.io/1731632039259541504/build-log.txt

linsun avatar Dec 04 '23 14:12 linsun

Thanks for the review @linsun, As discussed in our last slack chat, I will put the deployment section in a separate PR from this. I was able to get waypoint up and running but I will need your suggestions to structure the guide based on na and sa scope along with other additional factors around troubleshooting and authorization, etc. I've added a functional overview but not sure if it was imitated from a blog as I mostly referred resources around tutorials and design docs

fykaa avatar Dec 04 '23 18:12 fykaa

To resolve the missing link in lint, try rebasing your branch. It's a little behind master.

dhawton avatar Dec 26 '23 17:12 dhawton

Hi @fykaa can you pls let us know if you are still working on this? I saw Nina proposed a few small wording changes and I've committed them. If you aren't, we are happy to pick it up.

linsun avatar Jan 31 '24 20:01 linsun

Reviewers - may want to hold off reviews on this as @srampal and I discussed offline a while back, major rework will be required imho.

linsun avatar Jan 31 '24 20:01 linsun

Hi @fykaa can you pls let us know if you are still working on this? I saw Nina proposed a few small wording changes and I've committed them. If you aren't, we are happy to pick it up.

I would love to invest time on this, might need some directions though.

fykaa avatar Jan 31 '24 20:01 fykaa

Shall we get this ready to merge so we have something and we can then iterate on that?

craigbox avatar Mar 12 '24 01:03 craigbox

    ./en/docs/ops/ambient/usage/_index.md
        4 | owner: istio/wg-networking-maintainers 
        4 | owner: istio/wg-networking-maintainers 
>> 2 spelling errors found in 991 files

ummm wat

craigbox avatar Mar 12 '24 06:03 craigbox

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-sigs/prow repository.

istio-testing avatar May 03 '24 22:05 istio-testing