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

Published 20 hours ago • verified publisher icon istio

Move waypoint portion in L4 section to L7 section

Open linsun opened this issue 1 year ago • 7 comments

I found referring to waypoint in L4 section is quite confusing as users may not need waypoint at all and there is no intro to it either.

I suggest moving it to waypoint section.

linsun avatar Dec 04 '23 14:12 linsun

@srampal thoughts?

linsun avatar Dec 04 '23 14:12 linsun

Can I work on this @linsun?

husnialhamdani avatar Dec 20 '23 23:12 husnialhamdani

@linsun

TBH I dont think this change should be done at all. This section is not getting into any Waypoint details except showing that sometimes ztunnel may go through Waypoint. But it is still describing ztunnel behavior only, hence should remain in the ztunnel user's guide. We can chat to be clear but I dont think this change should be done at all.

On Mon, Dec 4, 2023 at 9:49 AM Lin Sun @.***> wrote:

@srampal https://github.com/srampal thoughts?

— Reply to this email directly, view it on GitHub https://github.com/istio/istio.io/issues/14252#issuecomment-1838804843, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACBPZUHZH4VTDSTIG3Z3BYLYHXPIDAVCNFSM6AAAAABAGDKOF6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMZYHAYDIOBUGM . You are receiving this because you were mentioned.Message ID: <istio/istio .@.***>

srampal avatar Dec 21 '23 03:12 srampal

@srampal I'd prefer our L4 user guide to be simple, if user doesn't need waypoint, I'd rather not mention it to avoid confusing them. Right now, the user guide is quite complex for ztunnel IMHO.

linsun avatar Jan 05 '24 22:01 linsun

cc @istio/wg-docs-maintainers to chime in

linsun avatar Jan 05 '24 22:01 linsun

I think I agree with @srampal that this section is only describing the ztunnel behavior so does belong in the ztunnel guide. What seems to be missing is a link to some waypoint doc (or maybe better yet, a glossary reference) for waypoint in this section and in the introduction. I think that would make it less confusing.

frankbu avatar Jan 08 '24 14:01 frankbu

@frankbu Thanks. There is a separate Waypoint doc in progress by another author and once thta is published, I will add a link to it in this doc as well along with additional planned updates. @linsun I think this issue can be closed based on my thinking and the additional feedback from Frank .. but I leave it to you to decide.

srampal avatar Jan 08 '24 17:01 srampal

I agree with @srampal that we need to keep documentation in the ztunnel docs on how the ztunnel sends traffic to waypoints.

I also agree that these docs are far too in-depth to be in the golden path for new Ambient users.

I'm going to close this, but I'm interested in hearing where the "separate Waypoint doc in progress by another author" ended up?

craigbox avatar Mar 07 '24 10:03 craigbox