docs: Update multi-hop concept doc #4552
Conversation
website/content/docs/concepts/connection-workflows/multi-hop.mdx
Outdated
Show resolved
Hide resolved
website/content/docs/concepts/connection-workflows/multi-hop.mdx
Outdated
Show resolved
Hide resolved
| Boundary client connections egress the proxy chain at this worker to reach the target. | ||
|
|
||
| Note that ingress, intermediary, and egress are general ways to describe how the respective worker interfaces with resources. | ||
| A worker can act as more than one of those at a time. | ||
|
|
||
| ## Multi-hop worker capabilities |
There was a problem hiding this comment.
Having read the preview, I'm thinking we move this section to be under the Introduction section, and we move the content from the Introduction section here and rename the header from Multi-hop worker capabilities to Multi-hop worker concepts. We talk about things upstream and downstream here currently, and if we move that to be under the introduction, then that is a good segway to better explain the concepts so users understand what was just mentioned in more detail.
There was a problem hiding this comment.
Having read the preview, I'm thinking we move this section to be under the
Introductionsection, and we move the content from theIntroductionsection here and rename the header fromMulti-hop worker capabilitiestoMulti-hop worker concepts. We talk about things upstream and downstream here currently, and if we move that to be under the introduction, then that is a good segway to better explain the concepts so users understand what was just mentioned in more detail.
Yep, great suggestion! I just moved these around and I think it flows nicely. I think this topic is much improved 🎉
I am wondering if we should expand on why people would want to configure multi-hop? We briefly address the benefits in the first para, but I'm wondering if it could be stronger.
There was a problem hiding this comment.
I reread the intro and thought about it some more, and honestly, Im coming up without any improvements. The value of multi-hop workers seems clear to me with that intro, but I also have been working with multi-hop workers a lot so perhaps another set of eyes on it would be good?
There was a problem hiding this comment.
Sounds good! I would like to bring in some other reviewers. Thank you for all your help @sdoyle88 . Robin and I still need to review your updates to the worker procedure too. We'll do those things and get back to you.
Co-authored-by: Sean Doyle <sdoyle88@users.noreply.github.com>
View the preview deployment