Skip to content
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.

Sign up for GitHub

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

feat: Add documentation for app-updated notifications for Nextcloud 29 #11622

Merged
merged 1 commit into from
Mar 11, 2024
Merged

feat: Add documentation for app-updated notifications for Nextcloud 29 #11622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions admin_manual/apps_management.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,25 @@ update all apps.
.. note:: **Beta releases**: You can also install beta releases of apps directly from here by
switching your Nextcloud to the beta channel in the admin overview.

Update notifications
^^^^^^^^^^^^^^^^^^^^

The always installed ``updatenotification`` app allows administrators to be notified on available app and Nextcloud updates.
Moreover, since Nextcloud 29, this app also allows to notify users about updated apps and the changes that are included in the update.
This notification is enabled by default if the app provides a changelog.

To disable user notifications use:

::

occ config:app:set --type boolean --value="false" updatenotification app_updated.enabled

By default guest users, when using the guests app, are not notified, to enable notifications also for them use:

::

occ config:app:set --type boolean --value="true" updatenotification app_updated.notify_guests

Using private API
-----------------

Expand Down
12 changes: 12 additions & 0 deletions developer_manual/app_development/info.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,3 +378,15 @@ The following elements are either deprecated or for internal use only and will f
* **remote**
* **requiremin**
* **requiremax**

.. _app changelog:

Changelog
---------

Apps can provide a changelog. This should be written in the `keep a changelog <https://keepachangelog.com/>`_.

If the apps provide a ``CHANGELOG.md`` file in the project root, this file will be used to show changes for the released version in the app store and for administrators in the app settings.

Moreover, since Nextcloud 29, if the ``updatenotification`` app is enabled, apps can also provide a changelog for the users.
The app will notify users about after the app update if either a ``CHANGELOG.language.md`` (where ``language`` is the language code of that user) or a fallback ``CHANGELOG.en.md`` is available.
2 changes: 2 additions & 0 deletions developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_29.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ General
-------

* The Circles app will be renamed to Teams. Apps that use the terms Circle/Circles need to get adjusted to use Team/Teams instead. For example ``share to circle`` would become ``share to team``.
* The ``updatenotification`` app now also supports notifications for apps that were updated.
If the updated app provides a ``CHANGELOG.language.md`` or ``CHANGELOG.en.md`` file, it will create notifications for users about these changes. See also the :ref:`app changelog<app changelog>` section.

info.xml
^^^^^^^^
Expand Down
Loading