Add v4 migration docs#78
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds and expands documentation for migrating from Dependency-Track v4 to v5, including guidance for running a v5 instance in parallel with v4 to validate behavior on real data before performing the one-shot migration.
Changes:
- Updates the upgrade guide landing page to point readers to the new v4→v5 migration guide.
- Replaces/expands the v4 migration doc into a detailed “Migrating from v4 to v5” procedure (phases, prerequisites, tuning, verification, recovery).
- Adds a new “Running v4 and v5 in parallel” guide (BOM upload replication via v4 notifications + Bento), along with screenshots and Vale vocabulary updates.
Reviewed changes
Copilot reviewed 5 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/upgrading/index.md | Adjusts upgrade guide intro text and links to the v4→v5 migration guide. |
| docs/guides/administration/running-v4-and-v5-in-parallel.md | New guide describing a parallel v4/v5 setup using BOM_PROCESSED notifications and Bento. |
| docs/guides/administration/migrating-from-v4.md | Major rewrite/expansion into a full v4→v5 migration runbook with caveats and operational guidance. |
| docs/guides/administration/.pages | Adds the new parallel-running guide to the administration nav. |
| docs/assets/images/guides/administration/running-v4-and-v5-in-parallel/create-alert.png | Screenshot used by the new parallel-running guide. |
| docs/assets/images/guides/administration/running-v4-and-v5-in-parallel/bento-api-key.png | Screenshot used by the new parallel-running guide. |
| .vale/styles/config/vocabularies/DependencyTrack/accept.txt | Adds migration-related terms to Vale’s accepted vocabulary. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nscuro
force-pushed
the
v4-migration-docs
branch
2 times, most recently
from
19ad3de to
3f99ecb
Compare
4 tasks
nscuro
force-pushed
the
v4-migration-docs
branch
4 times, most recently
from
6c6fa7f to
d0510e1
Compare
Signed-off-by: nscuro <nscuro@protonmail.com>
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
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.
API server PR: DependencyTrack/hyades-apiserver#2155