Tweak the EDD doc #184
Merged
Tweak the EDD doc #184
Conversation
This file contains hidden or 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
…ributing-docs into ps/tweaks
Deploying with
|
| Latest commit: |
da6951b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://570e7490.contributing-docs.pages.dev |
| Branch Preview URL: | https://ps-tweaks.contributing-docs.pages.dev |
withinfocus
requested changes
Aug 22, 2023
| @@ -32,73 +29,76 @@ For background on this decision please see the [Evolutionary Database Design RFD | |||
|
|
|||
| ## Design | |||
|
|
|||
| Database changes can be categorized into two categories: destructive and non-destructive | |||
| Database changes can be categorized into two categories: destructive and non-destructive changes | |||
| \[[1](./edd#further-reading)\]. A destructive change prevents existing functionality from working as | |||
There was a problem hiding this comment.
🎨 Can we link this to wording vs. a reference tag? Could link "two categories".
There was a problem hiding this comment.
It feels more like a foot note since the categories are denoted below and a link could be presumed to go to the categories within the document.
|
|
||
| #### Transition migration | ||
|
|
||
| The transition migration are run sometime during the transition phase, and provides an optional data |
There was a problem hiding this comment.
If adopting "migrations" for the transition migration definition, we should adopt it for the other two as well.
There was a problem hiding this comment.
I view this from the perspective of a single "change". In that scope it's singular migrations. However a deployment may contain multiple changes, and therefore multiple migrations.
|
|
||
| #### Transition migration | ||
|
|
||
| The transition migration are run sometime during the transition phase, and provides an optional data |
There was a problem hiding this comment.
If adopting "migrations" for the transition migration definition, we should adopt it for the other two as well.
withinfocus
approved these changes
Sep 15, 2023
joseph-flinn
approved these changes
Sep 21, 2023
joseph-flinn
added a commit
that referenced
this pull request
Sep 26, 2023
* Initial pass at updating our EDD database change processes * Fix file name of new image * Switch from 'rerunnable' to 'repeatable' * Push the quick fixes from feedback * Removed repeated use of Fowler's name as well as the repeated use of EDD * Fix the image caption * Removing all added personal pronouns * Use markdown text styling * Rename the application code version in the Phase definitions to be more clear * Update terminology definitions * Update language to be more focused * Accepted introduction summary improvements * Accepted suggested changes. * Accept revised defenition and examples of non-destructive changes * Update docs/contributing/database-migrations/edd.mdx Co-authored-by: Thomas Avery <[email protected]> * addtional updates * revert to JSX to fix the broken image link * Tweak the EDD doc (#184) --------- Co-authored-by: Thomas Avery <[email protected]> Co-authored-by: Oscar Hinton <[email protected]>
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.
No description provided.