[DOCU-1570] Improve README #2969
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ Deploy Preview for kongdocs ready! 🔨 Explore the source changes: bbd05ef 🔍 Inspect the deploy log: https://app.netlify.com/sites/kongdocs/deploys/60da4531c7b32700079b922f 😎 Browse the preview: https://deploy-preview-2969--kongdocs.netlify.app |
README.md
Outdated
|
|
||
| If you're making more than a small typo or grammar change, we ask that you pull down the repository and build locally. | ||
| * **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. |
There was a problem hiding this comment.
It's a bit more than just the admin API docs. Here's the full list:
Gateway OSS:
- Admin API
- Configuration reference: https://docs.konghq.com/gateway-oss/2.4.x/configuration/
- CLI reference: https://docs.konghq.com/gateway-oss/2.4.x/cli/
- PDK reference: https://docs.konghq.com/gateway-oss/2.4.x/pdk/
- Upgrade guide: https://docs.konghq.com/gateway-oss/2.4.x/upgrading/
For gateway OSS, open PRs against Kong/kong.
Gateway Enterprise:
Just the configuration reference (https://docs.konghq.com/enterprise/2.4.x/property-reference/)
For Gateway Enterprise, they should open a docs issue and we'll update the kong-ee repo (not publicly accessible).
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
lena-larionova
approved these changes
Jun 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Review
@Kong/team-docs
Summary
Reason
Addresses: Issues #809 and #1030
Testing
Tested locally via Atom Markdown previewer.