Add documentation for sulu 2->3 update#916
Conversation
05029e8 to
4955087
Compare
022e573 to
6330393
Compare
6330393 to
cc9f090
Compare
| php bin/console doctrine:migrations:migrate | ||
| php bin/adminconsole phpcr:migrations:migrate |
There was a problem hiding this comment.
Does the same, and running in website console is not required:
| php bin/console doctrine:migrations:migrate | |
| php bin/adminconsole phpcr:migrations:migrate | |
| php bin/console doctrine:migrations:migrate |
There was a problem hiding this comment.
phpcr migrations are not automatically executed via the doctrine:migrations command 🤔
but yes the adminconsole was not intentional
There was a problem hiding this comment.
oh this is 2.6 ? is migration bundle already there in 2.6 latest version? Else i think this is only should include the phpcr migrations
d0f3a8b to
68c8882
Compare
There was a problem hiding this comment.
Pull request overview
Adds a dedicated upgrade guide for moving from Sulu 2.6 to Sulu 3.0 (including the two-phase prep/migrate approach), and updates the existing upgrade index/generic upgrade guide to point to it and reflect Sulu 3.x upgrade steps.
Changes:
- Add a new
upgrade-2.6-3.0guide covering preparation on 2.6, switching to 3.0, and PHPCR → Doctrine migration steps. - Update the generic “upgrade within major” guide to reference the new 2.6 → 3.0 guide and include a Sulu 3.x database migrations step.
- Link the new guide from the upgrades index.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
upgrades/upgrade-2.x.rst |
Expands scope wording to include 3.x, links to the new 2.6→3.0 guide, and adds a Doctrine migrations step for Sulu 3.x. |
upgrades/upgrade-2.6-3.0.rst |
New end-to-end upgrade guide outlining recommended upgrade phases and common post-upgrade issues. |
upgrades/index.rst |
Adds the new 2.6→3.0 guide to the upgrades toctree. |
Comments suppressed due to low confidence (1)
upgrades/upgrade-2.x.rst:104
- This section points readers to the
UPGRADE.mdfile for BC breaks, but the referenced link target in this document is pinned to the3.0branch. Since this guide is now positioned as the generic “within-major” upgrade guide for both 2.x and 3.x, a fixed 3.0 link is likely to be outdated/misleading for other 2.x/3.x upgrades. Consider linking to a version-appropriate branch/tag (or explaining how to pick the correct UPGRADE.md for the target version).
4. Check the UPGRADE.md file for BC breaks
------------------------------------------
The `UPGRADE.md file`_ in the ``sulu/sulu`` repository contains all changes breaking backwards compatibility
between different versions. These changes might break your application if you have used the changed part of Sulu
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Upgrading Sulu 2.x and 3.x | ||
| ========================== |
| @@ -83,7 +97,7 @@ not fit your project. | |||
| For a convenient view of all changes in the skeleton repository, open https://github.com/sulu/skeleton/compare/ | |||
| and the select your current version as ``base`` and the target version as ``compare``. | |||
| **10. Reindex the search** | ||
|
|
||
| Populate the new search index (admin and website) with the migrated Sulu 3.0 data: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| php bin/console cmsig:seal:reindex --drop | ||
|
|
What's in this PR?
This PR adds a new upgrade guide for moving a project from Sulu 2.6 to Sulu 3.0. The guide explains the
preparation steps on Sulu 2.6. It also covers the switch to Sulu 3.0 and the PHPCR content migration.
The upgrade index now links to the new guide.
Why?
Sulu 3.0 changes the content storage architecture from PHPCR to Doctrine. Projects need a clear
migration path before running the final content migration. The guide describes the recommended order so
teams can prepare, migrate and verify their projects.