-
Notifications
You must be signed in to change notification settings - Fork 2.4k
feat(developermanual): move new and deprecated APIs to dedicated pages #14183
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| .. _database: | ||
|
|
||
| =============== | ||
| Database access | ||
| =============== | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| .. _deprecated-apis: | ||
|
|
||
| ============ | ||
| Deprecations | ||
| ============ | ||
|
|
||
| In order to improve our platform we are phasing out some APIs. Deprecated APIs are not removed before ???, | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ❓❓❓ lol
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Right. That brings up the old discussion about what we promise as deprecation period. IIRC it was three years. Should I write it down or skip?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @blizzz @nickvergessen do we state the 3y period? |
||
| unless the breakage can not be avoided. | ||
|
|
||
| We highly recommend using the `Nextcloud Rector <https://packagist.org/packages/nextcloud/rector>`_ | ||
| rules, which can fix some API changes automatically. | ||
|
|
||
| .. | ||
| Add one section for each group of deprecations (e.g. group files api changes, authentication changes). | ||
| Also deprecate the feature at their dedicated documentation page. | ||
| After branch-off the contents below will be cleared. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ============= | ||
| Release notes | ||
| ============= | ||
|
|
||
| This section is for developers and maintainers who are familiar with an earlier version of the documentation. | ||
|
|
||
| Here we try to summarize what's new. You will find the breaking changes at :ref:`upgrade_to_34`, new deprecations at :ref:`deprecated-apis` and new API features at :ref:`new-apis`. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 3 | ||
|
|
||
| new | ||
| deprecations | ||
| ../app_publishing_maintenance/app_upgrade_guide/upgrade_to_34 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| .. _new-apis: | ||
|
|
||
| =================== | ||
| New in this release | ||
| =================== | ||
|
|
||
| This pages covers new features of the platform. | ||
|
|
||
| .. | ||
| Add one section for each new feature. | ||
| Every feature should just have a brief description. Details have to be documented on a dedicated, persistent page. | ||
| After branch-off the contents below will be cleared. | ||
|
|
||
| Typed query builder | ||
| ------------------- | ||
|
|
||
| ``\OCP\DB\QueryBuilder\ITypedQueryBuilder`` was added in favour of ``\OCP\DB\QueryBuilder\IQueryBuilder`` and can be accessed through ``\OCP\IDBConnection::getTypedQueryBuilder``. | ||
|
|
||
| This query builder has the benefit of accurately returning the selected columns in a query result, increasing type safety. | ||
|
|
||
| .. todo:: This linked page does not have coverage for the new API. | ||
|
|
||
| See :ref:`database` for details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should also be a file per major for better linking?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like it. This will get messy quickly. It also makes it impossible to have a stable link as every major release will have the version embedded in the URL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could collect all current deprecations on this page. First we list the new ones, then there's the rest. When a deprecation is finally removed, it's also removed from the page.
It's equally messy, but there is one stable URL for the page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could have a second page then for those?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would grow endlessly