From ffe19ce12e7bdb0dd918c2ef751545e6aac17520 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Thu, 5 Sep 2024 22:09:46 +0200 Subject: [PATCH] chore: Cleanup developer manual The changelog section was very prominent but does not hold much useful information for developers. So get rid of it and just forward to the app upgrade guide (the maintained changelog). Signed-off-by: Ferdinand Thiessen --- developer_manual/conf.py | 7 +- developer_manual/digging_deeper/changelog.rst | 80 ------------------- developer_manual/digging_deeper/index.rst | 1 - user_manual_index.html | 2 +- 4 files changed, 6 insertions(+), 84 deletions(-) delete mode 100644 developer_manual/digging_deeper/changelog.rst diff --git a/developer_manual/conf.py b/developer_manual/conf.py index a0fa8cfb0..7770ac004 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -258,7 +258,7 @@ texinfo_documents = [ epub_title = u'Nextcloud Developer Manual' epub_author = u'The Nextcloud developers' epub_publisher = u'The Nextcloud developers' -epub_copyright = u'2012-2017, The Nextcloud developers' +epub_copyright = u'2012-2024, The Nextcloud developers' # The language of the text. It defaults to the language option # or en if the language is not set. @@ -318,10 +318,13 @@ highlight_options = { # Redirect old URLs # https://documatt.gitlab.io/sphinx-reredirects/usage.html redirects = { + # Removed 2023 "core/index": "../server", "core/code-back-end": "../server/code-back-end.html", "core/code-front-end": "../server/code-front-end.html", "core/externalapi": "../server/externalapi.html", "core/static-analysis": "../server/static-analysis.html", - "core/unit-testing": "../server/unit-testing.html" + "core/unit-testing": "../server/unit-testing.html", + # Removed 2024-09 + "digging_deeper/changelog": "../app_publishing_maintenance/app_upgrade_guide/index.html" } diff --git a/developer_manual/digging_deeper/changelog.rst b/developer_manual/digging_deeper/changelog.rst deleted file mode 100644 index a78f8f891..000000000 --- a/developer_manual/digging_deeper/changelog.rst +++ /dev/null @@ -1,80 +0,0 @@ -========= -Changelog -========= - -.. sectionauthor:: Bernhard Posselt - -Deprecations ------------- - -Deprecations are now documented by Nextcloud major release, not time. See :ref:`app-upgrade-guide`. - -Below is the old deprecation roadmap which lists older deprecations by year. - -.. note:: Deprecations on interfaces also affect the implementing classes! - -2018 -^^^^ - -* **OCP\\App::setActiveNavigationEntry** has been deprecated in favour of **\\OCP\\INavigationManager** -* **OCP\\BackgroundJob::registerJob** has been deprecated in favour of **OCP\\BackgroundJob\\IJobList** -* **OCP\\Contacts** functions has been deprecated in favour of **\\OCP\\Contacts\\IManager** -* **OCP\\DB** functions have been deprecated in favour of the ones in **\\OCP\\IDBConnection** -* **OCP\\Files::tmpFile** has been deprecated in favour of **\\OCP\\ITempManager::getTemporaryFile** -* **OCP\\Files::tmpFolder** has been deprecated in favour of **\\OCP\\ITempManager::getTemporaryFolder** -* **\\OCP\\IServerContainer::getDb** has been deprecated in favour of **\\OCP\\IServerContainer::getDatabaseConnection** -* **\\OCP\\IServerContainer::getHTTPHelper** has been deprecated in favour of **\\OCP\\Http\\Client\\IClientService** -* Legacy applications not using the AppFramework are now likely to use the deprecated **OCP\\JSON** and **OCP\\Response** code: - - * **\\OCP\\JSON** has been completely deprecated in favour of the AppFramework. Developers shall use the AppFramework instead of using the legacy **OCP\\JSON** code. This allows testable controllers and is highly encouraged. - * **\\OCP\\Response** has been completely deprecated in favour of the AppFramework. Developers shall use the AppFramework instead of using the legacy **OCP\\JSON** code. This allows testable controllers and is highly encouraged. - -* Diverse **OCP\\Users** function got deprecated in favour of **OCP\\IUserManager**: - - * **OCP\\Users::getUsers** has been deprecated in favour of **OCP\\IUserManager::search** - * **OCP\\Users::getDisplayName** has been deprecated in favour of **OCP\\IUserManager::getDisplayName** - * **OCP\\Users::getDisplayNames** has been deprecated in favour of **OCP\\IUserManager::searchDisplayName** - * **OCP\\Users::userExists** has been deprecated in favour of **OCP\\IUserManager::userExists** -* Various static **OCP\\Util** functions have been deprecated: - - * **OCP\\Util::linkToRoute** has been deprecated in favour of **\\OCP\\IURLGenerator::linkToRoute** - * **OCP\\Util::linkTo** has been deprecated in favour of **\\OCP\\IURLGenerator::linkTo** - * **OCP\\Util::imagePath** has been deprecated in favour of **\\OCP\\IURLGenerator::imagePath** - * **OCP\\Util::isValidPath** has been deprecated in favour of **\\OCP\\IURLGenerator::imagePath** - -* `OCP\\AppFramework\\IAppContainer `_: methods **getCoreApi** and **log** -* `OCP\\AppFramework\\IApi `_: full class - - -2017 -^^^^ - -* **OCP\\IDb**: This interface and the implementing classes will be removed in favor of **OCP\\IDbConnection**. Various layers in between have also been removed to be consistent with the PDO classes. This leads to the following changes: - - * Replace all calls on the db using **getInsertId** with **lastInsertId** - * Replace all calls on the db using **prepareQuery** with **prepare** - * The **__construct** method of **OCP\\AppFramework\\Db\\Mapper** no longer requires an instance of **OCP\\IDb** but an instance of **OCP\\IDbConnection** - * The **execute** method on **OCP\\AppFramework\\Db\\Mapper** no longer returns an instance of **OC_DB_StatementWrapper** but an instance of **PDOStatement** - -2016 -^^^^ - -* The following methods have been moved into the **OCP\\Template::** class instead of being namespaced directly: - - * **OCP\\image_path** - * **OCP\\mimetype_icon** - * **OCP\\preview_icon** - * **OCP\\publicPreview_icon** - * **OCP\\human_file_size** - * **OCP\\relative_modified_date** - * **OCP\\html_select_options** - -* **OCP\\simple_file_size** has been deprecated in favour of **OCP\\Template::human_file_size** -* The **OCP\\PERMISSION_** and **OCP\\FILENAME_INVALID_CHARS** have been moved to **OCP\\Constants::** -* The **OC_GROUP_BACKEND_** and **OC_USER_BACKEND_** have been moved to **OC_Group_Backend::** and **OC_User_Backend::** respectively -* `OCP\\AppFramework\\Controller `_: methods **params**, **getParams**, **method**, **getUploadedFile**, **env**, **cookie**, **render** - -2015 -^^^^ - -* `\\OC\\Preferences `_ and `\\OC_Preferences `_ diff --git a/developer_manual/digging_deeper/index.rst b/developer_manual/digging_deeper/index.rst index 374de7c19..368a2515f 100644 --- a/developer_manual/digging_deeper/index.rst +++ b/developer_manual/digging_deeper/index.rst @@ -6,7 +6,6 @@ Digging deeper :maxdepth: 3 api - changelog config/index debugging classloader diff --git a/user_manual_index.html b/user_manual_index.html index 6a98f8cb4..e0294e37e 100644 --- a/user_manual_index.html +++ b/user_manual_index.html @@ -3,7 +3,7 @@ Nextcloud Documentation - +