[DOCU-2595] decK upgrade guide: correct descriptions for sync, diff, validate #4666
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!
To edit notification comments on pull requests, go to your Netlify site settings. |
Guaris
approved these changes
Oct 28, 2022
lena-larionova
added a commit
that referenced
this pull request
Nov 9, 2022
…validate (#4666) fix description of deck sync, diff, and validate commands in upgrade guide
lena-larionova
added a commit
that referenced
this pull request
Nov 9, 2022
* [DOCU-2620] Deck Updates (#4640) * fix formatting * placeholder * deck updates * add changes to convert * fix content-type to content_type * [DOCU-2754] Overriding _plugin_configs for specific entities with decK (#4662) * add info about overriding specific fields in _plugin_configs * Update src/deck/guides/deduplicate-plugin-configuration.md Co-authored-by: Angel <Guaris@users.noreply.github.com> Co-authored-by: Angel <Guaris@users.noreply.github.com> * [DOCU-2595] decK upgrade guide: correct descriptions for sync, diff, validate (#4666) fix description of deck sync, diff, and validate commands in upgrade guide * [DOCU-2601] Secrets management with decK (#4661) * document secrets management with decK * rephrase * another rephrase * fix link * Apply suggestions from code review Co-authored-by: Angel <Guaris@users.noreply.github.com> * apply feedback; temp best practices section that needs filling out * split table comparing env variables with secrets into separate topic: * fill out best practices section * apply reviewer feedback Co-authored-by: Angel <Guaris@users.noreply.github.com> * decK: add env variable masking flag (#4749) * add --no-mask-deck-env-vars-value flag for 1.16 * formatting; appease vale Co-authored-by: lena.larionova <yelena.larionova@gmail.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
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.
Summary
Adjusting description for decK diff, sync, and validate command behavior in 3.0.
Reason
DOCU-2595
Previously the doc had two different descriptions for self-managed vs Konnect control planes for the sync, diff, and validate commands. The Konnect description was incomplete + misleading, so I fixed that, then tested all of the documented scenarios on Konnect and on a self-managed gateway instance and came to the conclusion that the control plane type (konnect vs self-managed) doesn't actually matter here. What makes the difference is the format version in the config file and the validity of the routes.
Testing
Netlify