Docs: Clarified Migration README: grammar, out-of-date, organization #2141
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
Signed-off-by: Kyle J. Davis <[email protected]>
stockholmux
changed the title
bcressey
reviewed
May 18, 2022
sources/api/migration/README.md
Outdated
|
|
||
| Migration code should not assume that any given keys exist, because migrations will be run on live data (where all keys will likely exist) and on pending data (where none, some, or all keys may exist). | ||
| Plus, different variants of Bottlerocket may not have the same keys. | ||
|
|
||
| The migration system could deserialize the function outputs into the incoming model types to confirm that the structure is valid; we should prototype this idea because it would add safety. | ||
| The migration system deserializes the function outputs into the incoming model types to confirm that the structure is valid. |
There was a problem hiding this comment.
This was more of a TODO comment; my sense is that it's not implemented.
There was a problem hiding this comment.
Ah. Gotcha. Inline it's not super clear that it's a todo.
What if we change the Open questions heading to Open questions and future directions and move this down to that section? That way all the maybe stuff goes into end of the document.
webern
reviewed
May 18, 2022
stockholmux
force-pushed
the
ds-migrations-readme-updates
branch
from
73d2b39
to
21dee00
Compare
webern
approved these changes
May 18, 2022
bcressey
approved these changes
May 19, 2022
Co-authored-by: Ben Cressey <[email protected]> Co-authored-by: Matthew James Briggs <[email protected]> Signed-off-by: Kyle J. Davis <[email protected]>
stockholmux
force-pushed
the
ds-migrations-readme-updates
branch
from
96de0c2
to
ff312b3
Compare
stockholmux
changed the title
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.
Signed-off-by: Kyle J. Davis [email protected]
Issue number: N/A
Description of changes:
Testing done: Its Markdown. I used my eyeballs.
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.