release notes for 3.0.0 rolling release#338
Conversation
ScharfViktor
requested review from
AlexAndBear,
Svanvith,
kulmann and
tbsbdr
and removed request for
Copilot
There was a problem hiding this comment.
Pull Request Overview
Adds a new “Release Notes” page for the v3.0.0 major release, updates the lifecycle table to include the v3.0.0 entry, and adjusts sidebar ordering for related docs pages.
- Introduce
release-notes.mdwith migration details and key breaking change examples - Update
lifecycle.mdto list v3.0.0 release date and download link - Shift sidebar positions in
demo-user.mdandcommon-issues.mdto accommodate the new page
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/admin/resources/release-notes.md | Add release notes content for v3.0.0 migration |
| docs/admin/resources/lifecycle.md | Insert v3.0.0 row into release lifecycle table |
| docs/admin/resources/demo-user.md | Update sidebar_position from 4 to 5 |
| docs/admin/resources/common-issues.md | Update sidebar_position from 3 to 4 |
ScharfViktor
force-pushed
the
publish-release-v3.0.0
branch
from
7ba0584 to
d6057d9
Compare
|
I added the link to the git hub release so the users can find more information and the download etc. |
rhafer
left a comment
rhafer
left a comment
There was a problem hiding this comment.
I'd suggest to make a bit more clear that the breaking change only affects people accessing the server via the GraphAPI.
Also breaking change happened to a different endpoint than what was mentioned.
| - Version: 3.0.0 | ||
| - Type: Major Release (Breaking Changes) | ||
| - [Details · Download](https://github.com/opencloud-eu/opencloud/releases/tag/v3.0.0) | ||
|
|
||
| ## Key Changes | ||
| ### Performance Optimization (Breaking Change) | ||
| #### Old Behavior: | ||
|
|
||
| ``` | ||
| GET /drives/{drive-id}/root/permissions | ||
| ``` | ||
|
|
||
| 👉 Automatically returned full permission details with all nested properties. | ||
|
|
||
|
|
||
| #### New Behavior: | ||
|
|
||
| ``` | ||
| GET /drives/{drive-id}/root/permissions?$select=@libre.graph.permissions.actions.allowedValues | ||
| ``` | ||
|
|
||
| 👉 Now requires explicit selection of needed fields. |
There was a problem hiding this comment.
- Version: 3.0.0
- Type: Major Release (Breaking Changes in the GraphAPI)
- Details · Download
Key Changes
The breaking change only affects software accessing OpenCloud via the GraphAPI. If you're accessing OpenCloud only via the clients provided by OpenCloud no migration is needed.
If you're using any other software that utilizes the GraphAPI, that software might need to be adjust to follow the new behavior of the GraphAPI. The following endpoints of the GraphAPI where changed in a way that is not backwards compatible with the previous releases:
GET /v1.0/me/drives/
GET /v1.0/drives/
GET /v1beta1/drives
GET /v1beta1/me/drives/
With the new release these endpoints do no longer automatically expand the all permissions the permissions on the drives' root items. If needed, the premission can be explicitly requested via the appropriate $expand query option.
part of opencloud-eu/opencloud#1029
We need explain users a reason major release so I created
release notespage and placed it close torelease lifecycleThere was suggestion to put it close to upgrade section (https://docs.opencloud.eu/docs/admin/maintenance/update) but in my opinion, I placed it in the right place.
I have tried to briefly explain the reason of major release. If you have any suggestions or recommendations, please let me know.