simpler docs #921
Merged
simpler docs #921
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
3 times, most recently
from
c445af5
to
6d211d7
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
4 times, most recently
from
fee2c36
to
93d4309
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
1431f29
to
acb6678
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
3 times, most recently
from
31dfc1f
to
ff6b484
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
5 times, most recently
from
bbfa3d8
to
6fcd1e9
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
6fcd1e9
to
5e6b2f3
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
5e6b2f3
to
f9be8b6
Compare
| @@ -621,4 +619,237 @@ Edges automatically create an `edge` label, for example: `edge=edghts_2gYaK9XAVa | |||
|
|
|||
| ::: | |||
|
|
|||
| <AgentConfigurations /> | |||
| ## Agent Configuration | |||
There was a problem hiding this comment.
I could try to get clever and piece out just the parts that are shared (now that v2 and v3 have diverged), but I instead copy-pasted and updated just the differences for v3.
This seems like a good call since:
- It's easier to change without causing regressions with the v2 fields (if were tried to share the markup)
- We're going to update these sections further, which makes anything that is "easy to throw away / delete" a good choice in my mind.
- It's grug brain and simple.
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
67b1a0c
to
0f4b05e
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
3 times, most recently
from
7fc2816
to
ec12181
Compare
| @@ -506,7 +181,7 @@ You can configure a single ngrok agent to start multiple endpoints to different | |||
| | [`policy.outbound.actions.type`](/docs/http/traffic-policy/actions/index.mdx) | String | `policy` has been renamed to `traffic_policy` in agent version 3.14.0. | | |||
| | [`policy.outbound.actions.config`](/docs/http/traffic-policy/actions/index.mdx) | custom | `policy` has been renamed to `traffic_policy` in agent version 3.14.0. | | |||
| | `proto` | `http` | The endpoint protocol name. This defines the type of endpoint you would like to start. | | |||
| | `proxy_proto` | String | The version of [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) to use with this endpoint, empty if not using. Example values are 1 or 2. | | |||
| | `proxy_protocol` | String | The version of [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) to use with this endpoint, empty if not using. Example values are 1 or 2. | | |||
There was a problem hiding this comment.
fixed naming
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
ec12181
to
a10bc9f
Compare
KristopherPaulsen
force-pushed
the
kc/simpler-docs
branch
from
a10bc9f
to
0b5e22d
Compare
KristopherPaulsen
requested review from
tammybailey
and removed request for
tammybailey
tammybailey
reviewed
Sep 9, 2024
tammybailey
approved these changes
Sep 9, 2024
docs/agent/config/v3.mdx
Outdated
| # | ||
| # List of TLS endpoint configuration fields: | ||
| # https://ngrok.com/docs/agent/config/v3/#tls-configuration | ||
| ### Endpoints with a traffic policy (file path) |
There was a problem hiding this comment.
I'm fine if you don't change it but Endpoints -> Endpoint (there's just one!)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improved the docs around v3 config to:
agent:agent configurations, but are instead top level fields (eg.version)agentThere's still a lot here to look over, so an extra pair of eyes is always nice!