feat: add documentation for changes to import/export functionality #124
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
markphelps
reviewed
Sep 28, 2023
| @@ -50,6 +50,15 @@ For convenience, you can supply `--create-namespace` in order for Flipt to autom | |||
| flipt import --namespace production --create-namespace flipt.yaml | |||
There was a problem hiding this comment.
i wonder if we should just remove the section on --create-namespace and the section about how the namespace must exist now?
There was a problem hiding this comment.
@markphelps Yeah I battled with this. I am for it, just was curious how many people are version upgrade averse.
operations/import-export.mdx
Outdated
|
|
||
| The `--namespaces` flag will accept a comma delimited list of namespaces from which you would like to export from. | ||
|
|
||
| The `--all-namespaces flag is a boolean flag which tells export to export all namespaces to the single file you specify, or to standard out by default. |
There was a problem hiding this comment.
Suggested change
| The `--all-namespaces flag is a boolean flag which tells export to export all namespaces to the single file you specify, or to standard out by default. | |
| The `--all-namespaces` flag is a boolean flag that tells export to export all namespaces to the single file you specify, or to standard out by default. |
operations/import-export.mdx
Outdated
|
|
||
| The `--namespace` flag is now deprecated, and two new flags now exist. | ||
|
|
||
| The `--namespaces` flag will accept a comma delimited list of namespaces from which you would like to export from. |
There was a problem hiding this comment.
Suggested change
| The `--namespaces` flag will accept a comma delimited list of namespaces from which you would like to export from. | |
| The `--namespaces` flag will accept a comma-delimited list of namespaces from which you would like to export from. |
operations/import-export.mdx
Outdated
| <Note> | ||
| In [v1.28.0](https://github.com/flipt-io/flipt/releases/tag/v1.28.0), we have extended this functionality to support exporting state from multiple namespaces to a single YAML file. | ||
|
|
||
| The `--namespace` flag is now deprecated, and two new flags now exist. |
There was a problem hiding this comment.
Suggested change
| The `--namespace` flag is now deprecated, and two new flags now exist. | |
| The `--namespace` flag is now deprecated. |
There was a problem hiding this comment.
This reminds me, we need to add this change to our https://github.com/flipt-io/flipt/blob/main/DEPRECATIONS.md file
markphelps
approved these changes
Oct 2, 2023
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.
Documentation for the new changes to the import/export functionality.
This change talks about the breaking changes in mdx Notes. The reason being that the previously existing documentation for import and export will still be relevant for some time due to people not being updated to the latest Flipt.
Completes FLI-617