Skip to content

docs(data-migrator): improve docs#8145

Open
tasso94 wants to merge 6 commits intomainfrom
data-migrator-improve-docs
Open

docs(data-migrator): improve docs#8145
tasso94 wants to merge 6 commits intomainfrom
data-migrator-improve-docs

Conversation

@tasso94
Copy link
Member

@tasso94 tasso94 commented Mar 5, 2026

Description

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@tasso94 tasso94 requested review from a team, Copilot and yanavasileva March 5, 2026 07:23
@tasso94 tasso94 self-assigned this Mar 5, 2026
@tasso94 tasso94 added the 8.6.0-alpha5 September 2024 alpha release label Mar 5, 2026
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Mar 5, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

👋 🤖 🤔 Hello, @tasso94! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.

  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/history-coverage.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/history.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/identity.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/index.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/install.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/limitations.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/runtime.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/index.md
  • docs/guides/migrating-from-camunda-7/migration-tooling/version-compatibility.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Data Migrator documentation for the upcoming 8.9 docs set, focusing on clearer navigation and more actionable usage guidance for runtime/history/identity migration.

Changes:

  • Reorganize History docs by adding a dedicated “History migration coverage” page and nesting it under a new History sidebar category.
  • Improve quick start + usage examples with OS-specific command tabs and expanded configuration snippets.
  • Update migration tooling metadata/wording and version compatibility to include the 0.3.x line.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
sidebars.js Nests History under Data Migrator and adds the new coverage page to navigation.
docs/guides/migrating-from-camunda-7/migration-tooling/version-compatibility.md Adds 0.3.x compatibility row for Camunda 8.9.
docs/guides/migrating-from-camunda-7/migration-tooling/index.md Updates Data Migrator description to reflect runtime + history migration.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/install.md Expands quick start with mode overview, config additions, and OS tabs for commands.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/runtime.md Renames page title/label and adds OS-specific usage tabs.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/history.md Renames page title/label, clarifies behavior, and adds OS-specific usage tabs + tenancy notes.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/identity.md Renames page title/label and adds OS-specific usage tabs.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/limitations.md Moves/condenses history-coverage details and adds a link to the new coverage page.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/index.md Updates mode descriptions/table contents to match new docs structure.
docs/guides/migrating-from-camunda-7/migration-tooling/data-migrator/history-coverage.md New page providing detailed history migration entity/property coverage tables.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@giorgionaps giorgionaps added 8.9.0-alpha5 and removed 8.6.0-alpha5 September 2024 alpha release labels Mar 5, 2026
@giorgionaps giorgionaps requested review from giorgionaps and removed request for a team March 5, 2026 12:50
@@ -1,26 +1,24 @@
---
id: history
title: History migration (experimental)
Copy link
Contributor

@giorgionaps giorgionaps Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was there a specific reason for deleting "migration" from titles here and for other docs? I feel like it was more descriptive before

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole tooling is about migration, and mentioning this word a 100 times makes it IMO not better readable but pretty redundant.

Copy link
Contributor

@giorgionaps giorgionaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great updates! I've left a couple comments/suggestions. Will be waiting for a re-review 👌

tasso94 and others added 4 commits March 5, 2026 17:38
…grator/install.md

Co-authored-by: Veronika Zvarych <122369346+giorgionaps@users.noreply.github.com>
…grator/index.md

Co-authored-by: Veronika Zvarych <122369346+giorgionaps@users.noreply.github.com>
…grator/index.md

Co-authored-by: Veronika Zvarych <122369346+giorgionaps@users.noreply.github.com>
@tasso94 tasso94 requested a review from giorgionaps March 5, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

3 participants