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

Require developers to update admin docs for critical changes

Browse Source 
Signed-off-by: Daphne Muller <86835268+DaphneMuller@users.noreply.github.com>
This commit is contained in:
Daphne Muller
2023-05-30 11:56:28 +02:00
committed by Christoph Wurst
parent c9799af58c
commit 78ecc9a233
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
developer_manual/prologue/compatibility_app_ecosystem.rst
View File

@@ -28,3 +28,8 @@ There are three procedures in place to facilitate communication to app developer
- 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 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.
Other documentation requirements
--------------------------------
A change that affects administrators who upgrade their Nextcloud should be documented in the release notes section of the admin documentation of that release.