Skip to content

Conversation

sg-writer
Copy link
Contributor

@sg-writer sg-writer commented Jul 14, 2025

bringing a clear purpose and standardized structure to the primary entry points into ngrok's key features:

  • Universal Gateway
    • Traffic Policy
    • Traffic observability
    • Identify and access management
    • Kubernetes Operator

@sg-writer sg-writer added docs/content Changes to the written material in the docs area/universal-gateway kind/prose-debt Refactoring content style, structure, or formatting (think: tech debt for docs) labels Jul 14, 2025
Copy link

vercel bot commented Jul 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ngrok-docs ✅ Ready (Inspect) Visit Preview Jul 28, 2025 7:05pm

@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 1755fa2 to 371aece Compare July 14, 2025 21:40
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 54a928c to 4fa67d9 Compare July 15, 2025 17:06
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 1be9756 to 5cda8ba Compare July 15, 2025 23:07
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from e78c3eb to 72b3d24 Compare July 17, 2025 18:11
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 0d6783f to d9aac91 Compare July 17, 2025 18:57
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 3a1cda2 to 7291853 Compare July 17, 2025 19:20
@sg-writer sg-writer marked this pull request as ready for review July 17, 2025 20:42
@sg-writer
Copy link
Contributor Author

@S3Prototype you can disregard my review request for the moment, going to heavily revise this page after getting feedback from Niji and probably repurpose a lot of this content on the "interior" overview pages.


Dive into the different parts of the Universal Gateway like Endpoints, Bindings, Pools, and Domains to understand how they work.
## Universal Gateway features
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about dropping "Universal Gateway" in these headings? So just "Features" and "Use cases"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a thought that it might help with SEO but I don't actually know if that's true. 🤷‍♂️ I don't have a strong opinion either way but your suggestion is definitely cleaner.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samcrichard and @jnbritton might have input in regard to SEO

- [TCP Addresses →](/universal-gateway/tcp-addresses/)
- [TLS Certificates →](/universal-gateway/tls-certificates/)
- [Edges →](/universal-gateway/edges/)
- [**Traffic Policy**](/docs/traffic-policy/): filter, match, manage, and orchestrate traffic to your endpoints.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ended up wrapped in the definition component, which is kind of interesting. I can update the code to not do that. How do you feel about it?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally don't know if it's a good or bad thing that's why I'm asking

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I kind of like it? It's the only proper noun / ngrokism on the list and I like that the definition component kind of underscores that and offers some reassurance that you're not expected to know what it is already.


[Endpoints](/universal-gateway/endpoints/) are how ngrok enables traffic to reach your services.
Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love these 👍

@sg-writer sg-writer changed the title Revise the Universal Gateway Overview page Revise the primary product overview pages Jul 28, 2025
@sg-writer
Copy link
Contributor Author

expanding the scope of this PR to include the other primary product overview pages.

@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 050e397 to fbb4da4 Compare July 28, 2025 18:28
@sg-writer sg-writer force-pushed the sg/doc-359-revise-the-universal-gateway-overview-page branch from 1f86b15 to 2b1d241 Compare July 28, 2025 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/content Changes to the written material in the docs kind/prose-debt Refactoring content style, structure, or formatting (think: tech debt for docs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants