Skip to content

Conversation

@tom-vx51
Copy link

@tom-vx51 tom-vx51 commented Nov 6, 2025

Rationale

Adds a section to the upgrading documentation to provide information about the new enterprise migration tool.

Changes

Add new section to the documentation.

Checklist

  • This PR maintains parity between Docker Compose and Helm

Testing

N/A

@tom-vx51 tom-vx51 requested a review from a team as a code owner November 6, 2025 00:46
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 6, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation for Enterprise Migration Tool
helm/docs/upgrading.md
Added comprehensive section "The Enterprise Migration Tool" under "Upgrading From Previous Versions", describing the enterprise-specific migration tool with installation, usage (migrate command, include/exclude filtering), and reversion procedures. Added matching TOC entry.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Verify documentation clarity and accuracy of migration tool instructions
  • Check formatting consistency with existing documentation sections
  • Confirm TOC entry aligns with new section heading

Poem

🐰 Hop along, migrations now documented clear,
The Enterprise Tool's guide appears right here,
Include, exclude, and revert with care,
FiftyOne's v2.13.0 upgrade made fair! 🚀

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation about the enterprise migration tool in the upgrading guide.
Description check ✅ Passed The description follows the template structure with all required sections (Rationale, Changes, Checklist, Testing) completed and provides clear context about the documentation addition.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 9fcb6fb and bc5c2cd.

📒 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 migrate command 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]>
@afoley587
Copy link
Member

This looks great. Should we update the A Note On Database Migrations section? I can also add the docker docs / polish things up once the core content is good if that's easier.

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
Copy link
Contributor

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?

Suggested change
fiftyone-migrator migrate 2.13.0
fiftyone-migrator migrate 2.14.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants