khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

feat(developer): Document the changes to the app ecosystem compatibility

Browse Source 
Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling
2023-05-04 08:50:19 +02:00
parent 6341513c38
commit d29254f3a8
2 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
developer_manual/app_publishing_maintenance/app_upgrade_guide/index.rst
View File

@@ -2,6 +2,8 @@
App upgrade guide
=================
.. _app-upgrade-guide:
Once you've created and published the first version of your app, you will want to keep it up to date with the latest Nextcloud features.
These sub pages will cover the most important changes in Nextcloud, as well as some guides on how to upgrade existing apps.

17
developer_manual/prologue/compatibility_app_ecosystem.rst
View File

@@ -16,18 +16,17 @@ Documentation procedures of changes that affect app developers
There are three procedures in place to facilitate communication to app developers about changes that affect them:
1. The definition of done of a pull request includes documentation.
This means the development of your pull request cannot be considered done if you introduced changes that affect app developers that you did not document.
1. The definition of **Done** of a pull request includes documentation.
.. TODO ON RELEASE: Change the link to the follow up issue
This means the development of your pull request cannot be considered done, if you introduced changes (additions, removals or modifications) that affect app developers that you did not document.
2. A change that affects app developers, has to be reported and documented by the author of the pull request in the `Changes for developers and administrators issue <https://github.com/nextcloud/server/issues/34692>`_.
The requirements for this documentation are:
2. A change that affects app developers, has to be reported and documented by the author of the pull request in the :ref:`App Upgrade guide <app-upgrade-guide>` section.
The requirements for this documentation are:
- It should be written so that app developers understand how to work around the change for their app in a tutorial format
- The steps should be explicitly written, so the documentation shall not rely upon links to external resources for the steps. While it is encouraged to add an external links as additional reference, it is a hard requirement that the documentation is readable and actionable without browsing to this link.
- The documentation has to be carefully written. The author's name will be added to the final publication so readers can reach out to the author if they have questions or if something is unclear.
- Timeline: the documentation is required to be handed in immediately after merging the pull request.
- The change author's name should be added to the section so readers can reach out to the author if they have questions or if something is unclear.
- Timeline: the documentation is required to be handed in when finalizing the pull request and should be merged timely close to the actual change.
3. The documentation will then be copy-pasted into the developer documentation and on the forum for the first beta release.
3. The documentation will then be copy-pasted into the forum for the first beta release.