Total review of guide #645
Conversation
Sorry that this is a heavy PR, but once I started hacking on this, all the changes ended up running into each other, so it was hard to break it all apart. The focus was primarily on making sure it was easy to understand the difference between "proxy mode" and "xds provider mode", fix bugs in the docs, update based on new features and improve general onboarding, as well as organise more of the documentation into folders. This included: * Add Agones to introduction * Put quickstarts in their own folder * Fix bug in ncat quickstart. * Rearranging the TOC to be clearer on proxy mode vs xDS. * Updates to Proxy Concepts * Mode top level metrics pages for proxy and xDS. * Update integration architectures to be prettier. * Updated integrations with new features. * Made headers semantically ordered across the docs. * Updates to the admin documentation. * Update FAQ * Split up xDS documentation into seperate sections * Generate and include command line help output. * Full update on Agones xDS provider inline with code functionality. Filed a few more issues on some extra documentation I would like to create at a later date, but I think this gives us a strong foundation to build on.
markmandel
requested review from
XAMPPRocky,
No-ops,
rezvaneh and
vallfors
as code owners
|
This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size. |
| @@ -9,28 +9,28 @@ on how you can use Quilkin in your multiplayer game networking architecture. | |||
| ## Server Proxy as a Sidecar | |||
|
|
|||
| ```text | |||
There was a problem hiding this comment.
We can do this on a separate PR, but I think these diagrams should be replaced with mermaid diagrams.
There was a problem hiding this comment.
Nice - https://github.com/badboy/mdbook-mermaid is a thing!
docs/src/proxy/maxmind.md
Outdated
| @@ -0,0 +1,19 @@ | |||
| # ASN Maxmind Information | |||
|
|
|||
| If Quilkin is provided a Maxmind IP Geolocation database through the `mmdb` | |||
There was a problem hiding this comment.
We accept file paths and URLs, so that should be mentioned as well.
There was a problem hiding this comment.
Ah good catch. Done.
|
This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size. |
|
Build Succeeded 🥳 Build Id: 8be61891-fea4-42d0-81e8-82ad15860ec0 The following development images have been built, and will exist for the next 30 days: To build this version: |
markmandel
added
kind/documentation
What type of PR is this?
/kind documentation
What this PR does / Why we need it:
Sorry that this is a heavy PR, but once I started hacking on this, all the changes ended up running into each other, so it was hard to break it all apart.
The focus was primarily on making sure it was easy to understand the difference between "proxy mode" and "xds provider mode", fix bugs in the docs, update based on new features and give a good overall flow of learning from one concept to another when doing initial onboarding.
This included:
Filed a few more issues on some extra documentation I would like to create at a later date, but I think this gives us a strong foundation to build on.
Which issue(s) this PR fixes:
Work on #546 (initially closes, but worth another check-in before making 0.4.0 release live)
Special notes for your reviewer:
Preview can be found on my fork: https://markmandel.github.io/quilkin/pr/docs/big-review/book/introduction.html
Review and feedback much appreciated!