-
Notifications
You must be signed in to change notification settings - Fork 1
docs(upgrading): add section on enterprise migration tool #455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughDocumentation expanded with a new section detailing FiftyOne Enterprise v2.13.0's enterprise-only migration tool. Includes installation steps, usage instructions (migrate, include/exclude options), reversion guidance, and corresponding table-of-contents entry. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
helm/docs/upgrading.md (1)
143-172: Wording improvement: Simplify "prior to" and "In the event that".Consider these documentation style improvements for clarity:
- Line 145: Replace "prior to" with "before"
- Line 176: Replace "In the event that" with "If"
These changes align with concise documentation practices.
Apply this diff:
- **IMPORTANT**: As with any database migration, Voxel51 **strongly** recommends - backing up your database prior to migrating. While many precautions are taken + **IMPORTANT**: As with any database migration, Voxel51 **strongly** recommends + backing up your database before migrating. While many precautions are taken- Migrations are designed to be bidirectional. In the event that you need to + Migrations are designed to be bidirectional. If you need to revert a migration, simply provide the version which you want to restore.Otherwise, the usage examples are well-documented and cover the key scenarios (all services, specific version, include/exclude options).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
helm/docs/upgrading.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
helm/docs/upgrading.md
[style] ~146-~146: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...y** recommends backing up your database prior to migrating. While many precautions are t...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~176-~176: ‘In the event that’ might be wordy. Consider a shorter alternative.
Context: ...tions are designed to be bidirectional. In the event that you need to revert a migration, simply ...
(EN_WORDINESS_PREMIUM_IN_THE_EVENT_THAT)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: pre-commit
- GitHub Check: docker-pulls
🔇 Additional comments (3)
helm/docs/upgrading.md (3)
21-21: TOC entry properly positioned and formatted.The new entry for "The Enterprise Migration Tool" is correctly placed in alphabetical sequence and follows the existing TOC structure.
121-126: Clear overview of enterprise migration tool purpose.The introduction effectively distinguishes the new enterprise-specific tool from the standard
fiftyone migratecommand and sets appropriate expectations.
128-141: Installation instructions are clear and complete.The two-step installation process with the private registry details is practical and sufficient for enterprise users with appropriate access.
Co-authored-by: afoley587 <[email protected]> Signed-off-by: Tom Schmidt <[email protected]>
|
This looks great. Should we update the |
Co-authored-by: Kevin DiMichel <[email protected]> Signed-off-by: Tom Schmidt <[email protected]>
| fiftyone-migrator migrate | ||
|
|
||
| # Migrate all enterprise services to a specific version | ||
| fiftyone-migrator migrate 2.13.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just released v2.14.0. Should we update the version here?
| fiftyone-migrator migrate 2.13.0 | |
| fiftyone-migrator migrate 2.14.0 |
Rationale
Adds a section to the
upgradingdocumentation to provide information about the new enterprise migration tool.Changes
Add new section to the documentation.
Checklist
Testing
N/A