Skip to content

Fix version specific notes #1607

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Fix version specific notes #1607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/updating/from_1.x_2.x/update_app_to_2.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ latest_tag: '2.5.27'

[[% include 'snippets/update/merge_composer.md' %]]

## 3. Update the app
## 3. Version Specific changes

First, perform version-specific steps depending on which version you are updating from.
When updating a release **earlier than v2.5.0**, some version-specific changes are required.
Copy link

@DominikaK DominikaK May 4, 2022

Choose a reason for hiding this comment

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

@reithor, in general, can you explain the reason for this change? We use the same structure for all update pages (see https://doc.ibexa.co/en/master/updating/from_3.3/update_from_3.3/#v332 for example), so changing it here would require reformulating the headings everywhere in the update section for consistency.
If I understand correctly and the issue is: "we are updating to v2.2, not from v2.2", I'd prefer rephrasing this introductory sentence:

Suggested change
When updating a release **earlier than v2.5.0**, some version-specific changes are required.
First, perform version-specific steps depending on which version you are updating to.

Copy link
Contributor Author

@reithor reithor May 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@DominikaK : changing the structure is not neccessary - I just thought it woul be clearer.
The whole point of the PR is that :
"A. v2.2" --> should be "A. Update from earlier than v2.2"
"B. v2.5" --> should be "B. Update from earlier than v2.5"


### A. v2.2
### A. Update from <=v2.1.1
Copy link
Contributor

@adriendupuis adriendupuis May 3, 2022

Choose a reason for hiding this comment

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

I would prefer

Suggested change
### A. Update from <=v2.1.1
### A. Update from earlier than v2.2

If not, maybe the use of ≤ instead of <=

Suggested change
### A. Update from <=v2.1.1
### A. Update from ≤v2.1.1

Copy link
Contributor Author

@reithor reithor May 3, 2022

Choose a reason for hiding this comment

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

but I am definitely fine with "from earlier than v2.2" (or v2.2.0)


When upgrading an Enterprise installation to v2.2, you need to disable `EzSystemsPlatformEEAssetsBundle` by removing
When updating from a release **<=v2.1.1** you need to disable `EzSystemsPlatformEEAssetsBundle` by removing
`new EzSystems\PlatformEEAssetsBundle\EzSystemsPlatformEEAssetsBundle(),` from `app/AppKernel.php`.

### B. v2.5
### B. Update from <=v2.4.2

Since v2.5 eZ Platform uses [Webpack Encore]([[= symfony_doc =]]/frontend.html#webpack-encore) for asset management.
You need to install [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/lang/en/docs/install) to update to this version.
Expand All @@ -34,6 +34,8 @@ In this case, use Webpack Encore. See [Importing assets from a bundle](../../gui

If you experience issues during the update, see [Troubleshooting](../../getting_started/troubleshooting.md#cloning-failed-using-an-ssh-key).

## 4. Update the app

### C. Run composer update

[[% include 'snippets/update/update_app.md' %]]
Expand Down