Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs on path handling algorithm in Kong 3.0 #4311

Merged
merged 4 commits into from
Aug 25, 2022

Conversation

windmgc
Copy link
Member

@windmgc windmgc commented Aug 24, 2022

Summary

From Kong 3.0, path handling v1 will be deprecated and when router_flavor == expressions, the field will be unconfigurable.

@windmgc windmgc requested a review from a team as a code owner August 24, 2022 09:34
@netlify
Copy link

netlify bot commented Aug 24, 2022

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit d32d29b
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/63074ebf1bf2ec00082441db
😎 Deploy Preview https://deploy-preview-4311--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@windmgc windmgc added review:tech Request for technical review on the docs platform or processes. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? labels Aug 24, 2022
@github-actions
Copy link
Contributor

⚠️ This PR edits generated files. Please make sure that the source file is updated.

https://github.com/Kong/kong/blob/master/autodoc/admin-api/data/admin-api.lua:

  • src/gateway/admin-api/index.md

@chronolaw
Copy link
Contributor

chronolaw commented Aug 24, 2022

router_flavor should be expressions, see PR #9263.

v1 is only available in traditional. both traditional_compat and expressions do not support v1.

@windmgc
Copy link
Member Author

windmgc commented Aug 24, 2022

sry for the typo, will fix

@Guaris
Copy link
Contributor

Guaris commented Aug 24, 2022

@windmgc
This doc is automatically generated by this file: https://github.com/Kong/kong/blob/master/autodoc/admin-api/data/admin-api.lua

Could you update that file as well?

@windmgc
Copy link
Member Author

windmgc commented Aug 25, 2022

Hi @Guaris I've updated the autodoc in Kong repo(see Kong/kong#9290), and synced up here too.

But I don't know whether I should keep this PR open, is it necessary that I modify the admin API doc here manually?(As you said there is an automatically process to generate this doc)

I'll leave it to you to decide :)

@mheap mheap added this to the Gateway 3.0 milestone Aug 25, 2022
@mheap mheap force-pushed the docs-deprecation-warning-on-path-handling branch from 22bd924 to 9bbbf82 Compare August 25, 2022 10:20
@mheap
Copy link
Member

mheap commented Aug 25, 2022

autodoc file has been updated. When it re-runs there will be Vale fixes to re-apply, but we want to rework the autodocs toolchain going forwards

@mheap mheap merged commit e859306 into release/gateway-3.0 Aug 25, 2022
@mheap mheap deleted the docs-deprecation-warning-on-path-handling branch August 25, 2022 10:37
Guaris added a commit that referenced this pull request Sep 10, 2022
* create single-source version gateway directory

* initialize gateway 3.0 doc

* remove versioned include folder; replace last versioned include

* Fix tests

* scrub out old baseplugin module (#3903)

* Archive Gateway documentation before 2.x (#3892)

* move everything before 2.0 into an archive directory
* set archive version to 2.0; link to archive netlify site
* add missing menu entry for enterprise dropdown
* update enterprise version
* Fix version switcher smoke tests

Co-authored-by: Michael Heap <m@michaelheap.com>

* Remove deprecated blacklist/whitelist params and single-source plugins (#3932)

* single-source ip restriction plugin, delete old versions

* single-source bot detection plugin, delete old version

* single source acl plugin, delete old version

* Fix field.maximum_version for plugin table

* add version-specific text; switch acl plugin to delegate_versions

* add missing note for ip restriction plugin

* apply feedback

Co-authored-by: Michael Heap <m@michaelheap.com>

* [ENGEN-450] Chore(debian 8): add deprecations of Debian 8 "Jessie" (#3944)

* chore(debian 8) add deprecation notice ala centos

* fix(ci) double wait timeout for netlify (w. 60)

* [ENGEN-453] chore(amzn) add amazon linux 1 deprecate notice (#3966)

* chore(amzn) add amazon linux 1 deprecate notice

* fix(amzn1) rm redundant dep notice lines

per PR feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* chore(*) remove config cache

* chore(xenial) add ubuntu 16.04 deprecate notice

* fix(httplog) update for 3.0 changes (#3929)

* fix(httplog) render custom_fields_by_lua properly

* change(httplog) update docs to 3.0.0

and clarify 2.x

* fix(http-log) fix example

* single-source the http log plugin docs

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* docs(gateway): dynamic plugin ordering (#3905)

* docs(gateway): dynamic plugin ordering

https://konghq.atlassian.net/browse/DOCU-2305

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* split plugin ordering doc into two; minor edits

* formatting, phrasing, typo cleanup; pulled 'workspaces' into 'performance limitations'

* docs(gateway): drop kong manager instructions

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* grammar, spelling, formatting cleanup; added info about Kong Manager to the overview

* fix typos; improve formatting and phrasing

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* feat(aws-lambda) refine docs; add two new params to aws-lambda plugin config (#3996)

* [DOCU-2349] GraphQL server path (#3960)

* add graphql_server_path; set up single-sourced version; minor grammar and formatting cleanup

* minor grammar edits

* set required: true for graphql_server_path

* attempt to rephrase

* [DOCU-2329] Linux OS support and deprecation (#4000)

* create one topic for all supported and deprecated linux OSes

* remove centos from 3.0 doc and set up redirect

* add links to support tables; move deprecation notices to changelog; remove link blocks

* remove unused 'os_version'

* add note to install doc; fix typo

* group linux distibutions into their own section

* update smoke test

* Fix `layout` type in Working with Templates (#4055)

Fix `layout` type

Changed `layout` type from boolean to string.

* update description of route.path about URI normalization (#4068)

* update description of route.path about URI normalization

* grammar

Co-authored-by: angel <angel.guarisma@konghq.com>

* docs(keyring) add recovery key for 3.0 (#4053)

* docs(keyring) add recovery key

* Fix typo

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add refer link

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* feat(plugin) add consumer_identifier_default, service_identifier_default and workspace_identifier_default (#4067)

* feat(plugin) add consumer_identifier_default, service_identifier_default and workspace_identifier_default

* copy edit

* changes to future proof this PR

* formatting issues

Co-authored-by: angel <angel.guarisma@konghq.com>

* docs(perf) add new API to perf test framework and mark it support (#4059)

* docs(perf) add new API to perf test framework and mark it support
Enterprise

* copy edit

Co-authored-by: angel <angel.guarisma@konghq.com>

* doc(keyring) reorder the structure, mention new options for Data Plane (#4097)

* doc(keyring) reorder the structure, mention new options for Data Plane

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add support for unlisted single-sourced docs

* chore/Copy changes from 2.8.x to src directory (#4125)

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4080

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4081

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4060

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4063

* copy chnges from https://github.com/Kong/docs.konghq.com/pull/4061

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4069

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4038, https://github.com/Kong/docs.konghq.com/pull/3999, https://github.com/Kong/docs.konghq.com/pull/3995, and https://github.com/Kong/docs.konghq.com/pull/3982

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4015

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3999

* copy changes from https://github.com/Kong/docs.konghq.com/commit/67b6df85f15d1ec0934d3bf85a811fceefaadafc

* copy changes from https://github.com/Kong/docs.konghq.com/commit/7e53c74288f782fbf29f278cbe86576160869562

* copy changes from  https://github.com/Kong/docs.konghq.com/pull/3950

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3948

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3925

* copy changes from https://github.com/Kong/docs.konghq.com/commit/e2c10402cb219b040b231e6223e7d33c6927f578

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3926

* copy changes from https://github.com/Kong/docs.konghq.com/commit/68a340e6e74ba67f0a420347243e668217c35ebb

* copy change from https://github.com/Kong/docs.konghq.com/commit/935189c9c23e22150323eaf0b145929fa159c9d7

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3807 and https://github.com/Kong/docs.konghq.com/commit/c3556fda9d32bcef7cbdf27358904984f9000852

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3895

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3861

* update nav for 3.0 and fix tests

* Single source plugin batch (#4136)

* single-source azure plugin

* single-source cors

* single-source exit transformer

* single-source graphql proxy cache

* single-source graphql rate limiting

* single-source newer plugins

* vale edits

* delete plugins that haven't existed for many releases

* redirects for removed plugin folders

* [DOCU-2402] Remove KM and decK, and HTTPie instructions from comprehensive docs. (#4137)

* remove KM, Deck, and HTTPIE instructions

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Integrate Diana feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [chore] Update 3.0 Config.md file (#4148)

update 3.0

* Add OpenTelemetry plugin for gateway 3.0 (#4154)

* wip

* add otel plugin

* add otel to nav bar

* Render map examples correctly in Plugin Hub

* Apply suggestions from code review

* Fix Vale issues

* Update version to single src

* add otel icon

* add recommendation & apply suggestions

* Apply suggestions from code review

* Update app/_hub/kong-inc/opentelemetry/_index.md

* Update app/_hub/kong-inc/opentelemetry/_index.md

Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* create single-source version gateway directory

* initialize gateway 3.0 doc

* remove versioned include folder; replace last versioned include

* Fix tests

* scrub out old baseplugin module (#3903)

* Archive Gateway documentation before 2.x (#3892)

* move everything before 2.0 into an archive directory
* set archive version to 2.0; link to archive netlify site
* add missing menu entry for enterprise dropdown
* update enterprise version
* Fix version switcher smoke tests

Co-authored-by: Michael Heap <m@michaelheap.com>

* Remove deprecated blacklist/whitelist params and single-source plugins (#3932)

* single-source ip restriction plugin, delete old versions

* single-source bot detection plugin, delete old version

* single source acl plugin, delete old version

* Fix field.maximum_version for plugin table

* add version-specific text; switch acl plugin to delegate_versions

* add missing note for ip restriction plugin

* apply feedback

Co-authored-by: Michael Heap <m@michaelheap.com>

* [ENGEN-450] Chore(debian 8): add deprecations of Debian 8 "Jessie" (#3944)

* chore(debian 8) add deprecation notice ala centos

* fix(ci) double wait timeout for netlify (w. 60)

* [ENGEN-453] chore(amzn) add amazon linux 1 deprecate notice (#3966)

* chore(amzn) add amazon linux 1 deprecate notice

* fix(amzn1) rm redundant dep notice lines

per PR feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* chore(*) remove config cache

* chore(xenial) add ubuntu 16.04 deprecate notice

* fix(httplog) update for 3.0 changes (#3929)

* fix(httplog) render custom_fields_by_lua properly

* change(httplog) update docs to 3.0.0

and clarify 2.x

* fix(http-log) fix example

* single-source the http log plugin docs

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* docs(gateway): dynamic plugin ordering (#3905)

* docs(gateway): dynamic plugin ordering

https://konghq.atlassian.net/browse/DOCU-2305

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* split plugin ordering doc into two; minor edits

* formatting, phrasing, typo cleanup; pulled 'workspaces' into 'performance limitations'

* docs(gateway): drop kong manager instructions

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* grammar, spelling, formatting cleanup; added info about Kong Manager to the overview

* fix typos; improve formatting and phrasing

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* feat(aws-lambda) refine docs; add two new params to aws-lambda plugin config (#3996)

* [DOCU-2349] GraphQL server path (#3960)

* add graphql_server_path; set up single-sourced version; minor grammar and formatting cleanup

* minor grammar edits

* set required: true for graphql_server_path

* attempt to rephrase

* [DOCU-2329] Linux OS support and deprecation (#4000)

* create one topic for all supported and deprecated linux OSes

* remove centos from 3.0 doc and set up redirect

* add links to support tables; move deprecation notices to changelog; remove link blocks

* remove unused 'os_version'

* add note to install doc; fix typo

* group linux distibutions into their own section

* update smoke test

* Fix `layout` type in Working with Templates (#4055)

Fix `layout` type

Changed `layout` type from boolean to string.

* update description of route.path about URI normalization (#4068)

* update description of route.path about URI normalization

* grammar

Co-authored-by: angel <angel.guarisma@konghq.com>

* docs(keyring) add recovery key for 3.0 (#4053)

* docs(keyring) add recovery key

* Fix typo

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add refer link

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* feat(plugin) add consumer_identifier_default, service_identifier_default and workspace_identifier_default (#4067)

* feat(plugin) add consumer_identifier_default, service_identifier_default and workspace_identifier_default

* copy edit

* changes to future proof this PR

* formatting issues

Co-authored-by: angel <angel.guarisma@konghq.com>

* docs(perf) add new API to perf test framework and mark it support (#4059)

* docs(perf) add new API to perf test framework and mark it support
Enterprise

* copy edit

Co-authored-by: angel <angel.guarisma@konghq.com>

* doc(keyring) reorder the structure, mention new options for Data Plane (#4097)

* doc(keyring) reorder the structure, mention new options for Data Plane

* Update src/gateway/plan-and-deploy/security/db-encryption.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add support for unlisted single-sourced docs

* chore/Copy changes from 2.8.x to src directory (#4125)

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4080

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4081

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4060

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4063

* copy chnges from https://github.com/Kong/docs.konghq.com/pull/4061

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4069

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4038, https://github.com/Kong/docs.konghq.com/pull/3999, https://github.com/Kong/docs.konghq.com/pull/3995, and https://github.com/Kong/docs.konghq.com/pull/3982

* copy changes from https://github.com/Kong/docs.konghq.com/pull/4015

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3999

* copy changes from https://github.com/Kong/docs.konghq.com/commit/67b6df85f15d1ec0934d3bf85a811fceefaadafc

* copy changes from https://github.com/Kong/docs.konghq.com/commit/7e53c74288f782fbf29f278cbe86576160869562

* copy changes from  https://github.com/Kong/docs.konghq.com/pull/3950

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3948

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3925

* copy changes from https://github.com/Kong/docs.konghq.com/commit/e2c10402cb219b040b231e6223e7d33c6927f578

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3926

* copy changes from https://github.com/Kong/docs.konghq.com/commit/68a340e6e74ba67f0a420347243e668217c35ebb

* copy change from https://github.com/Kong/docs.konghq.com/commit/935189c9c23e22150323eaf0b145929fa159c9d7

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3807 and https://github.com/Kong/docs.konghq.com/commit/c3556fda9d32bcef7cbdf27358904984f9000852

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3895

* copy changes from https://github.com/Kong/docs.konghq.com/pull/3861

* update nav for 3.0 and fix tests

* rebase

* [DOCU-2402] Remove KM and decK, and HTTPie instructions from comprehensive docs. (#4137)

* remove KM, Deck, and HTTPIE instructions

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Integrate Diana feedback

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [chore] Update 3.0 Config.md file (#4148)

update 3.0

* Add OpenTelemetry plugin for gateway 3.0 (#4154)

* wip

* add otel plugin

* add otel to nav bar

* Render map examples correctly in Plugin Hub

* Apply suggestions from code review

* Fix Vale issues

* Update version to single src

* add otel icon

* add recommendation & apply suggestions

* Apply suggestions from code review

* Update app/_hub/kong-inc/opentelemetry/_index.md

* Update app/_hub/kong-inc/opentelemetry/_index.md

Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Infrastructure Architecture navigation bar (#4173)

* Starting point

* IA rework

* netlify

* rename folder

* rename folder part 2

* reorder topologies section

* Update app/_data/docs_nav_gateway_3.0.x.yml

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* changes from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* How-To Kong (#4155)

* Adds how-to kong gateway to how-to section of docs

* Adds how-to request transformations

* Adds how-to request transformations

* Address Vale flagged errors

* updates kong how-to guide with new information on the quickstart script

* remove docker version

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Tidy copy around the mock request

* tidy copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy teardown instructions

* tidy cleanup instructions

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy request-transformation copy

* tidy request-transformation copy

* tidy copy for request-transformation how-to

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Use admin api env var instead of well known url

* Use connection env vars over well known localhost:ports

* tidy copy in request-transformations

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy in request-transformations.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy in request-transformations.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy in request-transformations.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy in request-transformations.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy copy in request-transformations.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Clarify the connection pre-reqs

* tidy copy in kong-gateway.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Tidy the kong-gateway how-to copy

* rebase

* tidy how-to/kong-gateway

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* tidy how-to/kong-gateway

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* how-to-kong tidy kong-gateway

* how-to request-transformations tidy copy

* mostly broken links

Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: angel <angel.guarisma@konghq.com>

* [DOCU-2418] Kong.conf config  (#4186)

* Configuration how-to, environment variables how-to

* Update src/gateway/kong-production/kong-conf.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/kong-production/kong-conf.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* use the kong gate way variable

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2419] Open Resty  (#4187)

* IA Open Resty

* retitle

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [fix] Port changes to serverless functions doc to Gateway 3.0  (#4199)

* Update plugin serverless-function scopes

* fix vale errors and copy edit

Co-authored-by: raoxiaoyan <13718259572@163.com>

* 3.0 Add status enum docs to Admin endpoint  (#4198)

* Add status enum docs to Admin endpoint

* mirror 4194 in 3.0 docs

Co-authored-by: Michael Heap <m@michaelheap.com>

* docs(perf) update perf test framework API (#4158)

* docs(perf) update perf test framework API

* Update performance-testing-framework.md

* Update performance-testing-framework.md

* Apply suggestions from code review

* Fix Vale issues

* docs(perf) add environment variables and more usage guides

* docs(perf) mention docker environment like gojira and pongo

* Fix Vale issues

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [docu-2420] Website and API in the same Kong Gateway instance (#4200)

* website and API same Kong

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* vale

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [Docu-2446] Nginx directives reference (#4202)

* nginx-directives

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2424] Kong in Production: Blue Green deployments (#4203)

* Move content

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Fix Vale issues

* Fix more Vale issues

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* docs(prometheus) add new options for 3.0 (#4183)

* docs(prometheus) add new options for 3.0

* Update for single sourcing

* Fix Vale issues

* Apply suggestions from code review

* fix(prometheus-switch-3.0.0): Adding 3.0.0 prometheus changelog docs (#4185)

* fix(prometheus-switch-3.0.0): Adding 3.0.0 prometheus changelog docs

* Apply suggestions from code review

* Add changelog to _index.md

* Bringing over example output from prometheus/_3.0.0.md to _index.md

* Delete 3.0.0.md

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix plugin version

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Hiroshi Fukada <hiroshi@fukada.us>

* [FTI-2203] tls-metdata-headers plugin docs (#3708)

* feat(plugin) add docs for tls-metadata-headers [FTI-2203]

* change compatible version

* Fix typo

* remove value_in_example props

* remove autogenerated examples

* Add more information to the docs

* add versions file and default icon; add plugin entry in compat table; clean up style & format; remove manually written examples and re-enable auto-examples

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* [FTI-2203] tls-handshake-modifier plugin docs (#3710)

* feat(plugin) docs for the tls-handshake-modifier plugin

1st draft of the docs. I copied the SNI section from the mtls-auth plugin since this plugins uses the same functionality.

* add icon; enable examples, exclude cloud; create version file; style cleanup; format for single-sourcing

* add plugin to compatibility table

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* Add tracing sections for gateway 3.0 (#4014)

* add tracing

* fix links

* fix broken links

* placeholder

* copy edit

* remove plugin development doc

* move tracing to kong production

Co-authored-by: angel <angel.guarisma@konghq.com>

* [docu-2441-2443] Write plugins in other languages (#4208)

* plugins in other languages docs

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* vale

* still vale

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2408] Understanding Kong: Services (#4201)

* Add services overview content

* Fix link

* Draft changes

* Add content

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Move service config section

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [chore] OPA documents undefined return 3.0 (#4212)

* [FT-2788]fix opa documents undefined return

* add missing config params

* copy edit + vale

* Mirror main branch open policy agent fix

Co-authored-by: windmgc <windmgc@gmail.com>

* Update smoke tests for new IA (#4213)

update smoke tests for new IA

* [DOCU-2413] and [DOCU-2447] Performance Testing Framework IA rework (#4210)

* Move content

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU 2411] and [DOCU-2444] Plugin Overviews (#4209)

* Add overview content, make include file

* Move content to include file

* Fix support link

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add other key concepts section

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2425] Kong in Production: Canary Deployments (#4206)

* Add canary content

* Update src/gateway/kong-production/canary.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Fix statsd plugin doc (#4225)

* feat(plugin) Merge statsd-advanced to statsd

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/_hub/kong-inc/statsd/_index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* indent to fix failing build

* Formatting + grammar

* More formatting

* single-source the statsd plugin

* set compatibility to true for OSS and EE

Co-authored-by: Yusheng Li <leeys.top@gmail.com>

* Port vaults doc updates into 3.0 (#4227)

* Vaults GA changes (#4226)

update some leftover instances of vaults=bundled

* port changes from 2.8 to 3.0; adjust for latest version

* vale edits

* [MA-365] Collect Prometheus metrics with Datadog (#4228)

* Create Datadog file

* fix(add-datadog-prometheus): docs

* Copyedit and add overview

* Update src/gateway/kong-production/monitoring/datadog.md

Co-authored-by: Hiroshi Fukada <hiroshi.fukada@konghq.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2429] Themes File reference (#4219)

* themes file reference

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2415] Configure Routes and Services (#4217)

* placeholder

* configure services and routes

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Diana suggestions

* title case

* vale and 404"

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* move dynamic plugin ordering docs into the right folder

* docs(plugins): update plugin priorities for 3.0 (#4246)

* docs(plugins): update plugin priorities for 3.0

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* Fix Vale issues

Signed-off-by: Joshua Schmid <jaiks@posteo.de>
Co-authored-by: Michael Heap <m@michaelheap.com>

* docs: fix issues with plugin-ordering examples (#4247)

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

Signed-off-by: Joshua Schmid <jaiks@posteo.de>

* DEVREL-372: Adds a how-to guide for PG Secrets via AWS Secrets Manager (#4233)

* DEVREl-372: Adds a how-to guide for PG Secrets via AWS Secrets Manager

* DEVREl-372: vale fixes

* DEVREl-372: fixes for vale and missing front matter header

* DEVREl-372: fix for docker env var non-export issue

Not sure why this is required at the moment, investigating. but for now
this fixes it

* DEVREl-372: tidy some copy

* DEVREl-372: tidy some copy

* DEVREl-372: tidy some copy

* Apply suggestions from code review

* DEVREl-372: Fixes indentation for numbered list

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [docu-2457] Router Reference, Router Route creation (#4251)

* router reference

* Check

* Add Router doc and reference doc

* vale

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [gateway]Automatic Jekyll rebuild when changing src Copy of #4252 (#4255)

Automatic Jekyll rebuild when changing src

Co-authored-by: Michael Heap <m@michaelheap.com>

* [DOCU-2445] Reference: Configuration Reference (#4207)

* Remove everything but params

* Apply suggestions from code review

* [DOCU-2409] Understanding Kong: Routes (#4216)

* Add overview content

* Edit routes overview content

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Edit routes overview

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2410] Understanding Kong: Upstreams (#4218)

* Add overview content

* Edit upstream overview

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2454][DOCU-1800] Konnect platform cleanup and cleanout (#4258)

* remove konnect platform 'doc set' and move useful content elsewhere

* consistent links to support policy

* adjust comments on wip compatibility table project

* update links

* remove konnect platform from tests and generators

* update pdf generation

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* add topics to 3.0; add missing section in Mesh; remove 'no_version:true'

* vale

* more vale edits

* adjust phrasing in availability stages include

* fix links

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* docs(router/atc) update to reflect the actual implementation in Kong 3.0 (#4259)

* docs(router/atc) update to reflect the actual implementation in Kong 3.0

* vale

Co-authored-by: angel <angel.guarisma@konghq.com>

* Kong Manger 3.0 documentation (#4077)

* docs(kong-manager) copyedit the docs for KM 3.0

* rework navigation for new IA plan

* delete completely empty topics

* delete files with duplicate content

* placeholder topics for content that needs to be written

* bring in up-to-date versions of topics; move content into auth section under Kong Manager

* rename files for clarity/parity with 2.8

* drafts of getting started content

* draft of workspaces and teams

* draft of enabling KM

* link updates and style cleanup

* modify setup include for versioning

* validate instructions; update links; add badges

* vale edits; style cleanup

* update links; style cleanup; more validation

* add an enable RBAC page; links; cleanup

* move workspaces and teams info to auth overview

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* turn giant lists into tables; generic company names; links

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* rename for simplicity; curl examples instead of httpie

* rename for simplicity

* update nav

* tabs for enable topic

* prereqs and consistency

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* ldap-auth-advanced changes for 3.0 (#4214)

* ldap-auth-advanced changes for 3.0

The config.groups_required parameter description is from the OIDC docs:
https://docs.konghq.com/hub/kong-inc/openid-connect/

* move changes for 3.0.x into index file

* single source ldap auth adv plugin

* vale edits

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* feat(statsd) update statsd document

* feat(statsd-advanced) add message for removing this plugin

* Apply suggestions from code review

* Update app/_hub/kong-inc/statsd/_index.md

* copy edit

* [DOCU-2291] Copy vaults GA edits to 3.0 (#4264)

copy vaults GA changes to 3.0; fix links; update nav

* [DOCU-2459] Gateway icons (#4268)

* update icons for 3.0

* switch getting started icon to learning

* [Docu 2470] Configure Rate Limiting (#4270)

* rate limiting plugin

* Apply suggestions from code review

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>

* Add `ssl_verify` option to OPA plugin (#3977)

* add https_verify to control if OPA certificate is verified

* Update app/_hub/kong-inc/opa/_index.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* rename to `ssl_verify`

* chore(*) add leading space

* Update app/_hub/kong-inc/opa/_index.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Mayo <i@shoujo.io>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* [Docu 2405] How to publish an API spec on Dev Portal (#4266)

* Dev Portal how-to

* fix

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* diana suggestion

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* add missing single quote (#4275)

* add missing single quote

* add regexes to dictionary

Co-authored-by: Hayk Sardaryan <hayk.sardaryan@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* [docu-2471] Proxy caching (#4277)

* placeholder

* proxy-caching

* fix issues

* Apply suggestions from code review

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>

* Adds required flag to get.konghq.com/quickstart script for adding a s… (#4273)

Adds required flag to get.konghq.com/quickstart script for adding a service

Related to discussion in DOCU-2414

* Fix breadcrumb links (#4271)

* All breadcrumbs linked as expected
* Only link if the breadcrumb is a valid URL
* Link breadcrumbs to /latest/ if on a latest URL
* Make breadcrumbs work at any depth

* [DOCU-2432] Kong Manager overview (#4278)

kong manager overview page with image

* [DOCU-2426] Kong Enterprise: Overview (#4263)

* Rough format

* Initial draft of content

* Add additional features

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Fix based on feedback

* make links consistent with Konnect overview

* fix links

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* [DOCU-2301] Mocking plugin: remove openapi2kong link (#4283)

* single-source the plugin properly

* remove link to openapi2kong; minor cleanup

* DOCU-2423: Adds StatsD monitoring page under Kong in Production (#4260)

* DOCU-2423: Adds StatsD monitoring page under Kong in Production

* DOCU-2423: Tidies copy

* Apply suggestions from code review

* DOCU-2423: Adds new -m flag which is required for the sample mock service

* Edit prereqs

* Apply suggestions from Rick

* DOCU-2423: Tidies some copy and clarifies the optional KG step

* copy edit

* more copy

* vale

* Update src/gateway/kong-production/monitoring/statsd.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: angel <angel.guarisma@konghq.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2311] Request transformer differences (#4285)

* document differences with oss and ee plugins

* single-source request transformer plugins; changelog entry for removed whitelist param

* vale edits

* [DOCU-2296] Serverless plugin: remove deprecated param and single-source (#4287)

* label deprecated functions param for previous versions; changelog; single-source serverless functions plugin

* appease vale

* DOCU-2422: Adds How to monitor with Prometheus (#4267)

* DOCU-2422: Adds How to monitor with Prometheus

* DOCU-2422: Vale fix

* DOCU-2422: Fixes that match PR 4260

* DOCU-2422: Adds new -m flag which is required for the sample mock service

* DOCU-2423: Edit for Adds new -m flag which is required for the sample mock service

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Removes sample mock request at start of guide

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* DOCU-2422: Updates from review feedback

* DOCU-2422: Updates from review feedback

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Add LMDB corruption FAQ (#4298)

Add LMDB FAQ page

* Update PDK docs for 3.0 (#4295)

* Update PDK docs for 3.0

* vale

Co-authored-by: angel <angel.guarisma@konghq.com>

* Remove config.cache in favour of LMDB (#4294)

Remove config.cache.json.gz from configuration reference

* Switch AWS Secrets Manager examples to use curl (#4291)

* [DOCU-2387] Workspace name is not editable (#4299)

delete obsolete topic; fix workspace name error

* [DOCU-2190][DOCU-2296] AWS Lambda plugin: remove proxy_scheme, update region and host, and single-source (#4288)

* set version on proxy_scheme param; single-source aws lambda plugin; adjust descriptions for aws_region and host for 3.0

* Update app/_hub/kong-inc/aws-lambda/_index.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [fix]Remove config cache (#4301)

remove config cache mention

* Config reference for 3.0 (#4302)

* update the config generation file; update the configuration reference for 3.0

* adjust heading levels; fix warning format

* move horizontal lines to be around sections, not around params

* Add apt-mark hold instructions to Ubuntu/Debian (#4313)

* Fix OSS switcher in non-codeblock examples

* Add apt-mark hold instructions to Ubuntu

* Add apt-mark hold instructions to Debian

* Add apt-mark hold instructions to Ubuntu (3.0)

* Add apt-mark hold instructions to Debian (3.0)

* Vale fixes

* [DOCU-2296] Acme plugin changes in 3.0 (#4307)

* add vault.auth_method default value

* new allow_any_domain param; single-source plugin

* Fix config.groups_required parameter for ldap-auth-advanced EE plugin (#4316)

* docs(*) hi-light referenceable fields in docs (#4310)

* docs(*) hi-light referenceable fields in docs

* linter edits

* fix typos to get build working

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>

* Automatic next/prev links for grouped content (#4317)

* Add automatic next/prev links for chapter based content

* Remove Next links from src

* Remove Next links from Gateway 2.8

* Remove Next links from Gateway 2.7

* Remove Next links from Gateway 2.6

* Remove Next links from Gateway 2.5

* Remove Next links from Gateway 2.4

* Remove Next links from Gateway 2.3

* Remove Next links from Gateway 2.2

* Remove Next links from Gateway 2.1

* Remove Next links from Gateway 2.0

* Remove missed Next link from Plugin tests

* Fix broken links

* docs(rate-limiting-advanced) disallow cluster strategy in DB-less or … (#4309)

docs(rate-limiting-advanced) disallow cluster strategy in DB-less or hybrid mode

* Titleize breadcrumbs (#4321)

Add titleize gem + filter

* DOCU-2414: Adds Get Kong to getting started guide (#4284)

* DOCU-2414: Adds Get Kong to getting started guide

This is the first PR in a series that will try and finzlie the
getting started guide for 3.0 release.  Follow up PRs will
standardize the other 6 pages to flow from this initial page and will
depend on it as a base for the getting started experience

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* DOCU-2414: Adds book & chapter front matter

* DOCU-2414: Remove manual next link, prep for book support

* Apply Review feedback

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2296] Plugins: Remove deprecated X-credential-username, single-source (#4318)

* removed x-credential-username in favor of x-credential-identifier; moved upstream headers info into an include

* conditional for upstream headers include

* single-source hmac auth; minor clean-up; bring back an overwritten feature update

* single-source basic auth

* single-source mtls-auth

* single-source key-auth-enc; minor tweak to mtls auth

* single-source key-auth

* remove conditionals from changelogs

* single-source ldap-auth plugin

* single-source oauth2-introspection plugin

* vale edits

* Fix smoke tests for newly linked breadcrumbs

* Path handling algorithm changes (#4311)

* Traditional / Clustering Topology (#4326)

Move Clustering Reference to Traditional deployment topology

* Custom Docker Builds (#4322)

Add custom Docker build instructions

* DOCU-2415: updates Services and Routes getting started section (#4304)

* DOCU-2415: Updates Services and Routes get-started section

* Apply review feedback

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* [DOCU-2416] Kong in Production> Topologies: Overview (#4269)

* First draft

* copy and rearrange

* Rework Traditional mode

* Reorder Hybrid>Traditional>DB-Less

* Rework DB-less mode

* Rework Hybrid mode

* Add Konnect topology

* Fix Jekyll build error

* Vale fixes

* Add Konnect CTA

* Move /overview/ to /

* copy

Co-authored-by: angel <angel.guarisma@konghq.com>
Co-authored-by: Michael Heap <m@michaelheap.com>

* Fix 2.8.x Overview link

* [docu-2475]Helm installation guides (#3886)

* helm-docs rebased to 3.0

* update for 3.0

* added PCP kubernetes as additional alternate path for non-localhost deployment

* polish for handoff to docs team

* removing preceeding spaces from codeblocks

* remove title variable

* remove 2.8.x document

* update 2.8.x document

* organize leading narrative

* reword title nav element

* copy edit

* rename

* remove development steps

* done

* update 2.8 version

* smoke tests

* fix conflicts

* one more broken link

Co-authored-by: usrbinkat <usrbinkat@braincraft.io>

* DOCU-2470: Updates the rate limiting section of the get-started guide (#4320)

* Docker custom build feedback (#4329)

Address Docker custom build feedback

* [DOCU-1563] Kong Glossary (#4319)

* place holder

* placeholder

* glossary

* Apply suggestions from code review

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>

* suggestions from code review

* Lena feedback

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* one more thing no ammend

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update src/gateway/understanding-kong/glossary.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* DOCU-2471: Updates proxy-caching get-started guide for 3.0 release (#4330)

* DOCU-2471: Updates proxy-caching get-started guide for 3.0 release

* DOCU-2471: Updates proxy-caching get-started guide for 3.0 release

* Update get-kong.md (#4336)

* Kong Gateway comparison table (#4315)

* Docu 2484 install index page (#4343)

* Add /install/ index page

* Set Gateway overview CTA

* Update src/gateway/kong-production/install-options/index.md

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Moved urls redirects (#4342)

Generate redirect for /latest/ on moved URLs

* Fix typo in Helm doc (#4344)

* Navbar updates (#4286)

* nav bar

* title case

* Re-apply changes from release branch

* Fix broken rebase

* Move get-started to index for breadcrumbs

* Move /install/ out of /kong-production/

* Move /licenses/ out of /kong-production/

* Move upgrade instructions under /upgrade/ folder

* Rename /other/ to /pluginserver/ in Plugin Development

* Rename use-cases -> index for Kong Plugins -> Auth

* Remove duplicate prefix, move graphql-quickstart to graphql

* Clean up Admin API nav

* Reference section cleanup

* Rename Stages of software availability to Stability

* Remove Rate Limit Library page

* DOCU-2415: updates Services and Routes getting started section (#4304)

* DOCU-2415: Updates Services and Routes get-started section

* Apply review feedback

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Fix Docker install instructions after rename

* Flatten Admin API navigation

* Move example files out of /admin-api/

* placeholder

* Move Securing the Admin API to Running Kong

* Move Understanding Kong guides to the relevant locations

* Split Key Concepts / How Kong works

* Manage Kong with decK is a Key Concept

* remove deck guide

* fix merge conflicts

* parity with spreadhsheet

* PR that contains cannonical URLS

* placeholder

* keyring and data encryption docs

* Rate limiting section restructured

* breadcrumb acronyms

* fix typo in header

* Update app/_data/docs_nav_gateway_3.0.x.yml

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* upgrade section top level directory move

* working but no redirects

* fix slash

* helm doc recommit

* Fix Rubocop for Alias generator

Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Rick Spurgeon <rspurgeon@users.noreply.github.com>
Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Add missing config options (#4339)

* add missing ipv6only and so_keepalive options

* add info on missing config options

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Fix KM guide link

* remove legacy attribute

* vale edit

* [fix] Empty pages, broken images, redirects (#4346)

* Remove circular references in moved_urls

* Get started fix route name (#4349)

* DOCU-2474: Removes workspaces and teams from the 3.0 get-started guide (#4338)

* DOCU-2474: Updates workspaces and teams for get-started guide

* DOCU-2474: Removes manage teams from the 3.0 get started workflow

* Fix smoke tests

* URL Structure Updates + Breadcrumbs (#4351)

* Remove unused /install-and-run/ path

* Move deployment-topologies to correct folder

* Output full path in breadcrumbs

* Add OSS to inflector for Titleize + Fix breadcrumbs for how-kong-works section

* URLs in install section. Fix breadcrumbs title

* Shorten nav sidebar entry text (Production)

* Sidenav update: Dev Portal

* Apply suggestions from code review

* Update /install/ index page (#4345)

* Update /install/ index page

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update src/gateway/install/index.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* fixing my typo; match styling to table

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Plugins 3.0 version matching and single-sourcing (#4331)

* single-source app reg plugin

* accurate versions according to eng testing and format cleanup

* canary plugin, align versions

* single-source grpc plugins

* single-source jwt plugin

* single-source plugins: proxy-cache, proxy-cache-adv, oauth2, openwhisk

* single-source rate limiting and rate limiting advanced

* single-source traffic control and transformations plugins

* single-source session plugin

* single-source logging plugins

* single-source loggly plugin

* use gateway strategy for remaining plugins with existing source files (no single-sourcing)

* fix tests and links

* single-source file-log plugin

* redirects for plugins

* vale edits

* Fix SEO noindex/canonical for old plugin versions

* added gateway version

* use exact URL for openwhisk redirect

Co-authored-by: Michael Heap <m@michaelheap.com>

* add / to canonical URL

* DOCU-2472: Updates the key auth get started page (#4335)

* DOCU-2472: Updates the key auth get started page

* DOCU-2472: uses key concepts links for services and routes

* DOCU-2472: vale fixes

* Fix "requester"

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Plugin Development title cleanup (#4357)

Remove 'Plugin Development - ' prefix from page titles

* DOCU-2473: Load Balancing get-started guide update (#4337)

* DOCU-2473: Updates load balancing get started guide

* Review feedback

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Get Started: Updates rate limiting advanced plugin discussion (#4353)

* Get Started: Updates rate limiting advanced plugin discussion

* Get Started: Vale fix

* Get Started: Updates rate limiting advanced plugin discussion

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update plugin priorities (#4358)

* plugin priorities for new plugins

* fix priority typos based on changelog; add missing plugins to OSS table

* Add ability to breadcrumb segment titles (#4356)

* Show intermediate breadcrumbs on index pages

* Add ability to specify breadcrumbs manually

* Move /production-deployment/ to /production/

* Rename /developer-portal/ to /dev-portal/

* Add ability to customise breadcrumb entry per-page

* Rename /vitals/ to /analytics/ in URLs

* Make breadcrumb lookup version independent

* Fix Rubocop errors

* Fix URLs with /vitals/

* Fix URLs with /dev-portal/

* Fix broken links

* Fix analytics search+replace

* Update CLI doc for 3.0 (#4362)

update cli doc for 3.0

* [DOCU-2469] Changelog for 3.0 (#4355)

* draft of changelog for 3.0

* Apply suggestions from code review

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>

* upgrade guide draft

* re-add hybrid mode considerations

* fix prometheus changelogs

* refactor upgrade guides

* add descriptions for new features; fix typo

* remove link to non-existent collector plugin

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/migrate-ce-to-ke.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* make topic subscription-level agnostic

Co-authored-by: Amy Goldsmith <59702069+acgoldsmith@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2306] Websocket validator functionality plugins (#4150)

* Add plugin skeletons

* websocket-size-limit WIP

* websocket-size-limit WIP

* websocket-size-limit WIP

* websocket-validator WIP

* websocket-size-limit WIP

* websocket-validator WIP

* websocket-validator WIP

* websocket-size-limit WIP

* s/unserialize/deserialize/

* the linter won't let me use 'unserialize' or 'deserialize'

* Fix style guide issues

* Add note to proxy WebSocket traffic

* Apply copyedits

* s/{service}/SERVICE/

* Update app/_hub/kong-inc/websocket-size-limit/_index.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix ascii sequence alignment

* WebSocket proxy mode docs

* proxy.md updates/fixes

* trying out navtabs for http/ws proto

* trying to fix the EE badge

* websocket pdk WIP

* Add to nav and add front matter

* Fix Vale issues

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update src/gateway/reference/proxy.md

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add WebSocket plugin handler docs

* Add blurb about oauth2 compatibility with WebSockets

* Attempt to fix EE badge

* whitespace cleanup

* remove nav tabs from the proxy reference doc

* fix websocket PDK links

* add ws/wss protocols to service/route object definitions

* remove enterpise badge template

* re-add enterprise badge in a span

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Michael Martin <3277009+flrgh@users.noreply.github.com>
Co-authored-by: Michael Martin <flrgh@protonmail.com>

* Update support policy table for 3.0.x.x (#4364)

update support policy for 3.0.x.x

* Update admin api doc for 3.0 (#4363)

* update admin api doc for 3.0

* bring back description of paths attribute

* Get Started: Adds cta to load balancing outro (#4359)

* DOCU-2421: Adds monitoring overview page (#4361)

* docs(*) fips (#4306)

* Fix merge marker issue

* Remove duplicate page titles (#4367)

* remove exact release name for deprecated params

* OpenID Connect plugin: label removed param (#4368)

update note for session_redis_auth; changelog entry

* Add `~` to paths attribute in plugins (#4370)

add ~ to paths attribute in plugins

* Zipkin plugin: updates for 3.0 (#4369)

* document timeout and http span path params

* single-source zipkin plugin

* label static_tags version; add 2.3.x changelog entry

* vale edits; remove source_url

* add missing tracing pdk to nav

* Broken links (#4372)

* Update links to Busted

* Remove Datadog link. Broken + not supported in 3.0 according to code

* Fix broken Vitals link

* Move all links from /kong-production/ to /production/

* Move /key-concepts/ out of /understanding-kong/ in URLs

* Fix security update process link

* First batch of broken links

* Second batch of broken links

* Third batch of broken links

* Fourth batch of broken links

* Fifth batch of broken links

* Sixth batch of broken links

* Seventh batch of broken links

* Eighth batch of broken links

* Ninth batch of broken links

* Tenth batch of broken links

* Eleventh batch of broken links

* Twelth batch of broken links

* Thirteenth batch of broken links

* Fourteenth batch of broken links

* Fix link in install_options table

* add missing support policy link to mesh nav

* Update plugin compatibility table (#4374)

add new plugins to compatibility table

* Add moved_urls.yml detection tool (#4377)

* Update default policy/strategy for rate limiting plugins (#4378)

* Update default policy/strategy for rate limiting plugins

* Changelog formatting

* appease linter

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update moved urls (#4373)

* update moved urls

* fix link

* Apply suggestions from code review

* Apply Helm chart feedback + fix sed inconsistenies (#4388)

remediate sed syntax inconsistency, formatting improvements, and add hyperlink references

* Clarify "unsupported" in installation table (#4392)

* Update End of Full Support dates for 2.6 and 2.7 (#4394)

Update End of Full Support dates for 2.6 and 2.7 (3.0 docs)

* Broken links, continued (#4375)

* fixing broken links

* fix more links

* use cached syntax

* remove old doc-assets images

* docs(gateway) add 3.0 dependencies versions (#4398)

* docs(gateway) add deps versions

* docs(ldap-auth-advanced) add 3.0 changelog entries

* update beta status for websockets (#4399)

* Changelog: Blue-green deployment fixes + missing info (#4400)

* fix info about blue-green in changelog and upgrade guide; update product name variables

* more info about blue-green based on eng discussion; add missing entry for ldap-auth-adv

* fix typo

* update smoke test

* Apply suggestions from code review

Fixing small copyedits

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add Gateway quick links section (#4396)

* Add Gateway quick links section

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Bump deck format version to 3.0 (#4405)

* bump deck format version to 3.0

* revert format version bump on openid-connect 1.5.x

* docs(secret-management) update secret management docs for GA (#4379)

* docs(secret-management) update secret management docs for GA

* fix links

* fix more links

* remove outdated source urls

* Formatting & grammar edits

* vale edits

* some better formatting for referenceable values section

Co-authored-by: lena.larionova <yelena.larionova@gmail.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Clean up command prompt marker (#4406)

* clean up command prompt marker in src and plugin hub

* remove outdated source_url parameter from plugin metadata

* fix some indents

* remove $ marker from hub examples

* Rename source_url to source_code for plugins (#4411)

rename source_url to source_code for plugins

* Add OpenTracing item to Known Limitations (#4414)

* Add OpenTracing item to Known Limitations

* Add deprecation notice for nginx-opentracing

* Minor copy editing improvements

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: Tyler Ball <2481463+tyler-ball@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* We accidently removed RFC3987 validation from route paths (#4415)

* We accidently removed RFC3987 validation from route paths

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

* Update app/gateway/changelog.md

Co-authored-by: Datong Sun <datong.sun@konghq.com>

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: Datong Sun <datong.sun@konghq.com>

* The FIPS package has an issue, so we are delaying the 3.0.0.0 release of that until we can fix the issue (#4416)

* The FIPS package has an issue, so we are delaying the 3.0.0.0 release of that until we can fix the issue

Reverts https://github.com/Kong/docs.konghq.com/pull/4306 temporarily
while we fix the FIPS package. When we release the 3.0.0.0 FIPS package
we will add these releae notes back.

Signed-off-by: Tyler Ball <tyler.ball@konghq.com>

…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:tech Request for technical review on the docs platform or processes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants