Add tutorial: multi-cloud API gateway #1161
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…rok-docs into joelhans/multicloud-api-gateway
| ## Deploy a demo API service (optional) | ||
|
|
||
| If you don't yet have API services you'd like to bring online with a multi-cloud | ||
| API gateway, or just want to quickly wire up a POC using ngrok, we recommend | ||
| running multiple "replicas" of [httpbin](https://httpbin.org/), which is simple | ||
| HTTP request and response service. | ||
|
|
||
| Assuming you have Docker installed on the systems where your API services run, | ||
| you can deploy an httpbin container listening on port `8080`. | ||
|
|
||
| ```shell | ||
| docker run -p 8080:80 -d kennethreitz/httpbin | ||
| ``` | ||
|
|
||
| Repeat this process on your other cloud providers where you want to run replicas | ||
| of your API service. |
There was a problem hiding this comment.
Maybe we should move this section to the bottom of the page since it's optional, and (I assume?) users are probably already going to have an API service they're interested in using with this tutorial
There was a problem hiding this comment.
I agree that it might be a distraction for those who already have an API service, but I don't know about moving it to the end. Maybe it could be a collapsible section that's hidden by default?
These "choose your own adventure" moments are part of why I asked about whether we could implement a component that asks a few questions of the user, then conditionally renders the tutorial based on their answers.
In this case, we would ask upfront whether they want a demo service or are bringing their own. If they're bringing their own, we'd hide this and any other mention of said demo service. But—that's not in scope for this one.
| Repeat this process on your other cloud providers where you want to run replicas | ||
| of your API service. | ||
|
|
||
| ## Bring your multi-cloud API gateway online |
There was a problem hiding this comment.
| ## Bring your multi-cloud API gateway online |
I know they're all over the docs, but I'm kind of against these empty headings. I understand that they give a theme to the content under them. But they also make the TOC look cluttered by forcing everything under them to go down a heading level, and tend to be redundant. For example, the page is already called "Deploy a multi-cloud API gateway" so it's not 100% necessary to have a whole heading telling readers they're going to "Bring your multi-cloud API gateway online"
What do you think?
Making this change would require putting all the sub headings up a level
There was a problem hiding this comment.
Not a bad idea! I tested this out in the changes I'm pushing momentarily. The TOC has more H2-level items, but maybe that's overall clearer.
|
@S3Prototype Thanks for the comments so far! I've just focused on your comments at this point, and will plan on doing the more stylistic pass later this week. |
This PR adds a new tutorial for wiring up ngrok as a multi-cloud API gateway.
Reviews and improvements aside, this is ready to fly once we're OK with endpoint pools.
A few things to note: