From e018efc4f633d352b6a9c2a90297d70b2cf2398a Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Thu, 24 Jun 2021 21:27:21 -0700 Subject: [PATCH 01/12] update intro and run info --- README.md | 65 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 42 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d7b4b7ba8bf5..b3f265f9f277 100644 --- a/README.md +++ b/README.md @@ -2,42 +2,53 @@ # KONG's Documentation Website -This repository provides the source code and content for [Kong](https://github.com/Kong/kong)'s documentation website. It is a [Jekyll](https://jekyllrb.com/) website deployed with Netlify. +This repository holds source code for [Kong](https://github.com/Kong/kong)'s documentation website. It's a [Jekyll](https://jekyllrb.com/) website deployed with [Netlify](https://www.netlify.com/). -Not sure where to start? Head on over to the `issues` tab to and look for the `good first issue` label. These are issues Kong has identified as beginner friendly. Many of these can be addressed with the GitHub UI and do not require pulling the repository and building locally. +If you'd like to contribute, head on over to [Issues](https://github.com/Kong/docs.konghq.com/issues). New beginners can find issues with the `good first issue` label, some of which can be handled via the GitHub GUI. -First-time contributors, check out our [contributing guide on the website](https://docs.konghq.com/contributing/), and the linked resources there. +Before submitting an issue or PR, please review our [Contributing Guide](https://docs.konghq.com/contributing/). -## Building locally +If you're looking to contribute to our open source API gateway, see our [Kong/kong](https://github.com/Kong/kong) repository. -If you're making more than a small typo or grammar change, we ask that you pull down the repository and build locally. +## Run local project -### Develop locally with Docker +For anything other than minor changes, clone the repository onto your local machine and build locally. We offer the option to build with or without Docker. -``` -make install-prerequisites -``` +## Run local project with Docker -> -```bash -make develop -``` +### Prerequisites -### Running a local build with Docker +- [gulp](https://gulpjs.com/docs/en/getting-started/quick-start/) globally +- [Docker](https://www.docker.com/products/docker-desktop)(Note that you will not need to run the Docker container via Docker Desktop.) -Install tools: +### Install dependencies and start container + +Install dependencies: ``` make install ``` -Run the build: +Start the Docker container: +``` +make develop +``` + +### Run project using Docker + ``` make run ``` -Check the build output at http://localhost:3000. +Check the Docker build output at http://localhost:3000. + +### Troubleshoot Docker issues + +If you have issues getting the build output, you can try re-installing and re-running your build with: +``` +make clean && make run +``` -### Testing links with Docker +### Test links with Docker ``` make check-links @@ -51,24 +62,32 @@ make check-links - [yarn](https://classic.yarnpkg.com) - [gulp](https://gulpjs.com/docs/en/getting-started/quick-start/) - [Bundler](https://bundler.io/) (< 2.0.0) -- [Ruby](https://www.ruby-lang.org) (>= 2.0, < 2.3) +- [Ruby](https://www.ruby-lang.org) (> 2.6) - [Python](https://www.python.org) (>= 2.7.X, < 3) -### Install +### Install dependencies > -```bash +``` gem install bundler npm install ``` -### Run +### Run project using npm > -```bash +``` npm start ``` +Check the build output at http://localhost:8000. + +### Test links + +``` +make check-links-local +``` + ### Generate the PDK, Admin API, CLI, and Configuration documentation The PDK docs, Admin API docs, `cli.md` and `configuration.md` for each release are generated from the Kong source code. From 2c55ceb60698a5cad86a8d041d10fa7bbabaf0c5 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Fri, 25 Jun 2021 14:02:05 -0700 Subject: [PATCH 02/12] add badge content and update run instructions --- README.md | 85 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 50 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index b3f265f9f277..7af98d0a305f 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,69 @@ [![Netlify Status](https://api.netlify.com/api/v1/badges/ae60f2a4-488e-4771-b24a-c26badc5f45d/deploy-status)](https://app.netlify.com/sites/kongdocs/deploys) +[![](https://img.shields.io/github/license/kong/docs.konghq.com)](https://github.com/Kong/docs.konghq.com/blob/main/LICENSE) +[![](https://img.shields.io/github/contributors/kong/docs.konghq.com)]() # KONG's Documentation Website -This repository holds source code for [Kong](https://github.com/Kong/kong)'s documentation website. It's a [Jekyll](https://jekyllrb.com/) website deployed with [Netlify](https://www.netlify.com/). +This repository holds source code for [Kong](https://github.com/Kong/kong)'s documentation website. It's built using [Jekyll](https://jekyllrb.com/) and deployed with [Netlify](https://www.netlify.com/). -If you'd like to contribute, head on over to [Issues](https://github.com/Kong/docs.konghq.com/issues). New beginners can find issues with the `good first issue` label, some of which can be handled via the GitHub GUI. +Here are some things to know before you get started: -Before submitting an issue or PR, please review our [Contributing Guide](https://docs.konghq.com/contributing/). +* **We're beginner-friendly**. Whether you're a Technical Writer getting into code-as-docs or an engineer practicing your documentation skills, we highly encourage your involvement in our project. If you'd like to contribute and don't have something in mind already, head on over to [Issues](https://github.com/Kong/docs.konghq.com/issues). We've added `good first issue` labels on beginner-friendly issues. -If you're looking to contribute to our open source API gateway, see our [Kong/kong](https://github.com/Kong/kong) repository. +* **We need more help in some areas**. We'd especially love some help with [plug-in](https://github.com/Kong/docs.konghq.com/tree/main/app/_hub) documentation. + +* **Our _Admin API_ docs are auto-generated**. That means that all PRs for ADMIN API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. + +* **Community is a priority for us**. Before submitting an issue or PR, please review our [Contributing Guide](https://docs.konghq.com/contributing/). ## Run local project +*** -For anything other than minor changes, clone the repository onto your local machine and build locally. We offer the option to build with or without Docker. +For anything other than minor changes, clone the repository onto your local machine and build locally. We offer the option to run you project locally with Docker, gulp, and npm. -## Run local project with Docker +## Run locally with Docker +*** ### Prerequisites -- [gulp](https://gulpjs.com/docs/en/getting-started/quick-start/) globally -- [Docker](https://www.docker.com/products/docker-desktop)(Note that you will not need to run the Docker container via Docker Desktop.) - -### Install dependencies and start container +- [Docker](https://www.docker.com/products/docker-desktop) (You will not need to run the Docker container via Docker Desktop.) -Install dependencies: -``` -make install -``` +### Start container -Start the Docker container: +Start the Docker container (this installs dependencies for you and may take a few minutes): ``` make develop ``` -### Run project using Docker - +If you have issues, run: ``` -make run +make clean ``` -Check the Docker build output at http://localhost:3000. +## Run locally with gulp +*** -### Troubleshoot Docker issues +### Prerequisites + +- [gulp](https://gulpjs.com/docs/en/getting-started/quick-start/) installed globally -If you have issues getting the build output, you can try re-installing and re-running your build with: +Install dependencies: +``` +make install ``` -make clean && make run -``` -### Test links with Docker +Run the project: +``` +make run +``` +If you have issues, run: ``` -make check-links +make clean ``` -## Develop locally without Docker +## Run locally with npm +*** ### Prerequisites @@ -65,30 +74,36 @@ make check-links - [Ruby](https://www.ruby-lang.org) (> 2.6) - [Python](https://www.python.org) (>= 2.7.X, < 3) -### Install dependencies -> +Install dependencies: ``` gem install bundler npm install ``` -### Run project using npm - -> +Run the project: ``` npm start ``` -Check the build output at http://localhost:8000. +## Plug-in contributors + +If you have contributed a plug-in, we welcome you to add a Kong badge to your plug-in README. -### Test links +Use the following where you replace `test` with your plug-in name and `link-to-docs` with a link to the Kong docs for your plug-in. ``` -make check-links-local +[![](https://img.shields.io/badge/Kong-test-blue.svg?colorA=042943&colorB=00C4BB&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAIAAAAC64paAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABl0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC4xOdTWsmQAAAIcSURBVDhPY2DRdCYb0Vgzh46btlcCmiAEEdDMb+w9a+Xmr99/FHdM49R1R5PFp5nPyHvfifP/weDvv39LNu4SMfdHVoBPs2VY9q4jpx8+ewnRDwRHz13h1veAK8CpmdfQq6xrRt2EeS7xxc9evYVovvf4mbhlIFwNTs1JlV1///4Fajh96UZIbt2nL1+B7B8/fznGFsDVYNcsYRX04jXUtn///m3ae7SgZcrnr9/aZixBDjYsmnn0Pe2j85++fAPRDAR///6btGitWXAGu7Yrskp0zaLmAWt2HLxy+35UUcvHzyCnQsCv37/zWiaxabkgK0ZoFrMIMA3OOH/t9j+w6j3HzmbW9wE9CeaBwJdv30PyGuDqgQiqWdDU9/TlG99//IQqBHt1wbodjZMX/PnzByr0///rdx+sI3JQNAMT4ML1O6HySOD3nz+FbVOBUsAUAhUCx5aqawxCc2HbFKA9UEmwHqATgOjdx092UXmCJr57j5+DyoHBqUs3RC0CoJqRXfv795/sxol+GVVA5JJQzK3vCVQgZx92+eY9qApI5O07BtUMFQODGcs3RRY1v3zzHug9IJq4cA3QU0A1+r7JT168hir6/x/IZtVyQdF85spNYGYAOunh0xcQEWAM5TRNBKoBIo/ksi9fv0PEgdEJFAFpvnbnARBduH4Hnm+BKQkiCETAMGfTBkWviJn/3mNnIYKp1d1QzWQiTWcA1wsS5+E9q+MAAAAASUVORK5CYII=)](link-to-docs) ``` -### Generate the PDK, Admin API, CLI, and Configuration documentation +Here's how the badge looks: [![](https://img.shields.io/badge/Kong-test-blue.svg?colorA=042943&colorB=00C4BB&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAIAAAAC64paAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABl0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC4xOdTWsmQAAAIcSURBVDhPY2DRdCYb0Vgzh46btlcCmiAEEdDMb+w9a+Xmr99/FHdM49R1R5PFp5nPyHvfifP/weDvv39LNu4SMfdHVoBPs2VY9q4jpx8+ewnRDwRHz13h1veAK8CpmdfQq6xrRt2EeS7xxc9evYVovvf4mbhlIFwNTs1JlV1///4Fajh96UZIbt2nL1+B7B8/fznGFsDVYNcsYRX04jXUtn///m3ae7SgZcrnr9/aZixBDjYsmnn0Pe2j85++fAPRDAR///6btGitWXAGu7Yrskp0zaLmAWt2HLxy+35UUcvHzyCnQsCv37/zWiaxabkgK0ZoFrMIMA3OOH/t9j+w6j3HzmbW9wE9CeaBwJdv30PyGuDqgQiqWdDU9/TlG99//IQqBHt1wbodjZMX/PnzByr0///rdx+sI3JQNAMT4ML1O6HySOD3nz+FbVOBUsAUAhUCx5aqawxCc2HbFKA9UEmwHqATgOjdx092UXmCJr57j5+DyoHBqUs3RC0CoJqRXfv795/sxol+GVVA5JJQzK3vCVQgZx92+eY9qApI5O07BtUMFQODGcs3RRY1v3zzHug9IJq4cA3QU0A1+r7JT168hir6/x/IZtVyQdF85spNYGYAOunh0xcQEWAM5TRNBKoBIo/ksi9fv0PEgdEJFAFpvnbnARBduH4Hnm+BKQkiCETAMGfTBkWviJn/3mNnIYKp1d1QzWQiTWcA1wsS5+E9q+MAAAAASUVORK5CYII=)](link-to-docs) + +See [Issue #908](https://github.com/Kong/docs.konghq.com/issues/908) for more information. Note that we're not currently hosting assets for badges. + +## Generate the PDK, Admin API, CLI, and Configuration documentation +*** + +> This section is for Kong source code maintainers. You won't need to do anything here if you're contributing to this repo! The PDK docs, Admin API docs, `cli.md` and `configuration.md` for each release are generated from the Kong source code. From 75d24a23154903c85e56b926c55088869ffae8c2 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Fri, 25 Jun 2021 14:38:51 -0700 Subject: [PATCH 03/12] cleanup --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7af98d0a305f..84f18440b240 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,7 @@ npm start ``` ## Plug-in contributors +*** If you have contributed a plug-in, we welcome you to add a Kong badge to your plug-in README. From 1dcc041bedae877302a0234f15a822c566401980 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Fri, 25 Jun 2021 15:03:10 -0700 Subject: [PATCH 04/12] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84f18440b240..f9fec899f818 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Here are some things to know before you get started: ## Run local project *** -For anything other than minor changes, clone the repository onto your local machine and build locally. We offer the option to run you project locally with Docker, gulp, and npm. +For anything other than minor changes, clone the repository onto your local machine and build locally. We offer the option to run your project locally with Docker, gulp, and npm. ## Run locally with Docker *** From c988126bcf5117ef1816fe14bc7ea08b45700bea Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:34:44 -0700 Subject: [PATCH 05/12] plug-in -> plugin Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9fec899f818..120efc9013bb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Here are some things to know before you get started: * **We're beginner-friendly**. Whether you're a Technical Writer getting into code-as-docs or an engineer practicing your documentation skills, we highly encourage your involvement in our project. If you'd like to contribute and don't have something in mind already, head on over to [Issues](https://github.com/Kong/docs.konghq.com/issues). We've added `good first issue` labels on beginner-friendly issues. -* **We need more help in some areas**. We'd especially love some help with [plug-in](https://github.com/Kong/docs.konghq.com/tree/main/app/_hub) documentation. +* **We need more help in some areas**. We'd especially love some help with [plugin](https://github.com/Kong/docs.konghq.com/tree/main/app/_hub) documentation. * **Our _Admin API_ docs are auto-generated**. That means that all PRs for ADMIN API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. From 0c7522b7cc01010d339ad40992bf56f2003b05e6 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:34:57 -0700 Subject: [PATCH 06/12] plug-in -> plugin Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 120efc9013bb..de7eb8e23507 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Run the project: npm start ``` -## Plug-in contributors +## Plugin contributors *** If you have contributed a plug-in, we welcome you to add a Kong badge to your plug-in README. From 6803a8015cdf46f0f2022c808a87f89b17574814 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:35:13 -0700 Subject: [PATCH 07/12] plug-in -> plugin Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index de7eb8e23507..855411cb7e55 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ npm start ## Plugin contributors *** -If you have contributed a plug-in, we welcome you to add a Kong badge to your plug-in README. +If you have contributed a plugin, we welcome you to add a Kong badge to your plugin README. Use the following where you replace `test` with your plug-in name and `link-to-docs` with a link to the Kong docs for your plug-in. From 2beec7bbbd622cbad122dfbc8a6cfae7d27a07aa Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:35:47 -0700 Subject: [PATCH 08/12] plug-in -> plugin Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 855411cb7e55..e67b6e619bce 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ npm start If you have contributed a plugin, we welcome you to add a Kong badge to your plugin README. -Use the following where you replace `test` with your plug-in name and `link-to-docs` with a link to the Kong docs for your plug-in. +Use the following, where you replace `test` with your plugin name and `link-to-docs` with a link to the Kong docs for your plugin. ``` [![](https://img.shields.io/badge/Kong-test-blue.svg?colorA=042943&colorB=00C4BB&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAIAAAAC64paAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABl0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC4xOdTWsmQAAAIcSURBVDhPY2DRdCYb0Vgzh46btlcCmiAEEdDMb+w9a+Xmr99/FHdM49R1R5PFp5nPyHvfifP/weDvv39LNu4SMfdHVoBPs2VY9q4jpx8+ewnRDwRHz13h1veAK8CpmdfQq6xrRt2EeS7xxc9evYVovvf4mbhlIFwNTs1JlV1///4Fajh96UZIbt2nL1+B7B8/fznGFsDVYNcsYRX04jXUtn///m3ae7SgZcrnr9/aZixBDjYsmnn0Pe2j85++fAPRDAR///6btGitWXAGu7Yrskp0zaLmAWt2HLxy+35UUcvHzyCnQsCv37/zWiaxabkgK0ZoFrMIMA3OOH/t9j+w6j3HzmbW9wE9CeaBwJdv30PyGuDqgQiqWdDU9/TlG99//IQqBHt1wbodjZMX/PnzByr0///rdx+sI3JQNAMT4ML1O6HySOD3nz+FbVOBUsAUAhUCx5aqawxCc2HbFKA9UEmwHqATgOjdx092UXmCJr57j5+DyoHBqUs3RC0CoJqRXfv795/sxol+GVVA5JJQzK3vCVQgZx92+eY9qApI5O07BtUMFQODGcs3RRY1v3zzHug9IJq4cA3QU0A1+r7JT168hir6/x/IZtVyQdF85spNYGYAOunh0xcQEWAM5TRNBKoBIo/ksi9fv0PEgdEJFAFpvnbnARBduH4Hnm+BKQkiCETAMGfTBkWviJn/3mNnIYKp1d1QzWQiTWcA1wsS5+E9q+MAAAAASUVORK5CYII=)](link-to-docs) From c05007b6fb773e4538da156e15d0c3e31dbcc9a9 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:58:13 -0700 Subject: [PATCH 09/12] add auto-gen doc list --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e67b6e619bce..97e87e6ce69f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,15 @@ Here are some things to know before you get started: * **We need more help in some areas**. We'd especially love some help with [plugin](https://github.com/Kong/docs.konghq.com/tree/main/app/_hub) documentation. -* **Our _Admin API_ docs are auto-generated**. That means that all PRs for ADMIN API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. +* **Some of our docs are auto-generated**. + * Admin API + * [Configuration reference](https://docs.konghq.com/gateway-oss/latest/configuration/) + * [CLI reference](https://docs.konghq.com/gateway-oss/latest/cli/) + * [Upgrade guide](https://docs.konghq.com/gateway-osslatest/upgrading/) + +All PRs for ADMIN API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. + +For [Gateway Enterprise configuration reference](https://docs.konghq.com/enterprise/latest/property-reference/) and [PDK reference](https://docs.konghq.com/gateway-oss/latest/pdk/) documentation, open an issue on this repo and we'll update the docs. * **Community is a priority for us**. Before submitting an issue or PR, please review our [Contributing Guide](https://docs.konghq.com/contributing/). From 04b0586f0b88e711dd25dc112507c80ae3325930 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 10:59:32 -0700 Subject: [PATCH 10/12] add admin api link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97e87e6ce69f..cb80af192a48 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,12 @@ Here are some things to know before you get started: * **We need more help in some areas**. We'd especially love some help with [plugin](https://github.com/Kong/docs.konghq.com/tree/main/app/_hub) documentation. * **Some of our docs are auto-generated**. - * Admin API + * [Admin API](https://docs.konghq.com/gateway-oss/) * [Configuration reference](https://docs.konghq.com/gateway-oss/latest/configuration/) * [CLI reference](https://docs.konghq.com/gateway-oss/latest/cli/) * [Upgrade guide](https://docs.konghq.com/gateway-osslatest/upgrading/) -All PRs for ADMIN API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. +All PRs for Admin API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. For [Gateway Enterprise configuration reference](https://docs.konghq.com/enterprise/latest/property-reference/) and [PDK reference](https://docs.konghq.com/gateway-oss/latest/pdk/) documentation, open an issue on this repo and we'll update the docs. From 7311f970077fc42e621f9a2c212115bfbb471022 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 14:54:44 -0700 Subject: [PATCH 11/12] typo Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb80af192a48..894c165bbf54 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Here are some things to know before you get started: * [CLI reference](https://docs.konghq.com/gateway-oss/latest/cli/) * [Upgrade guide](https://docs.konghq.com/gateway-osslatest/upgrading/) -All PRs for Admin API should be open over at the [Kong/kong](https://github.com/Kong/kong) repository. +All PRs for these docs should be opened over at the [Kong/kong](https://github.com/Kong/kong) repository. For [Gateway Enterprise configuration reference](https://docs.konghq.com/enterprise/latest/property-reference/) and [PDK reference](https://docs.konghq.com/gateway-oss/latest/pdk/) documentation, open an issue on this repo and we'll update the docs. From bbd05efcb1088bd33d010c1db2e412915d00f9f1 Mon Sep 17 00:00:00 2001 From: Falon Darville Date: Mon, 28 Jun 2021 14:54:54 -0700 Subject: [PATCH 12/12] typo Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 894c165bbf54..c765ce07b79d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Here are some things to know before you get started: * [Admin API](https://docs.konghq.com/gateway-oss/) * [Configuration reference](https://docs.konghq.com/gateway-oss/latest/configuration/) * [CLI reference](https://docs.konghq.com/gateway-oss/latest/cli/) - * [Upgrade guide](https://docs.konghq.com/gateway-osslatest/upgrading/) + * [Upgrade guide](https://docs.konghq.com/gateway-oss/latest/upgrading/) All PRs for these docs should be opened over at the [Kong/kong](https://github.com/Kong/kong) repository.