diff --git a/admin_manual/apps_management.rst b/admin_manual/apps_management.rst index 7843902760b..751fffd66c3 100644 --- a/admin_manual/apps_management.rst +++ b/admin_manual/apps_management.rst @@ -30,8 +30,7 @@ have an **Featured**-tag. and custom consulting for supported apps, contact our `sales team `_. .. note:: If you would like to develop your own Nextcloud app, you can find out - more information in our `developer manual `_. -.. TODO ON RELEASE: Update version number above on release + more information in our `developer manual `_. All apps must be licensed under AGPLv3+ or any compatible license. diff --git a/admin_manual/configuration_files/big_file_upload_configuration.rst b/admin_manual/configuration_files/big_file_upload_configuration.rst index f49d11ec71d..9b792d4c40c 100644 --- a/admin_manual/configuration_files/big_file_upload_configuration.rst +++ b/admin_manual/configuration_files/big_file_upload_configuration.rst @@ -48,8 +48,6 @@ through WebDAV single file PUT requests or `Chunked file uploads `_ For those, PHP and webserver timeouts are the limiting factor on the upload size. -.. TODO ON RELEASE: Update version number above on release - Adjust these values for your needs. If you see PHP timeouts in your logfiles, increase the timeout values, which are in seconds:: @@ -171,8 +169,6 @@ to the actual file on the Nextcloud servers temporary directory. It is recommend the size of your temp directory accordingly and also ensure that request timeouts are high enough for PHP, webservers or any load balancers involved. -.. TODO ON RELEASE: Update version number above on release - .. tip:: In more recent versions of Nextcloud Server, when uploading to S3 in *Primary Storage* mode, we use S3 `MultipartUpload`. This allows chunked upload streaming of the chunks directly to S3 so that the final MOVE request no longer needs to assemble the final file on the Nextcloud server. This requires your ``memcache.distributed`` to be set to use Redis (or Memcached), otherwise we fall back on the prior behavior which consumes space on the Nextcloud Server for file assembly (as described above). Federated Cloud Sharing @@ -180,5 +176,3 @@ Federated Cloud Sharing If you are using `Federated Cloud Sharing `_ and want to share large files, you can increase the timeout values for requests to the federated servers. Therefore, you can set ``davstorage.request_timeout`` in your ``config.php``. The default value is 30 seconds. - -.. TODO ON RELEASE: Update version number above on release diff --git a/admin_manual/configuration_files/encryption_details.rst b/admin_manual/configuration_files/encryption_details.rst index 4bf6806083a..56b3b1cd6cb 100644 --- a/admin_manual/configuration_files/encryption_details.rst +++ b/admin_manual/configuration_files/encryption_details.rst @@ -356,5 +356,3 @@ Sources - `Sourcecode: Generation of the File Key `_ - `Sourcecode: Generation of the Initialization Vector `_ - `Sourcecode: Generation of a Key Pair `_ - -.. TODO ON RELEASE: Update version number above on release diff --git a/admin_manual/configuration_files/file_sharing_configuration.rst b/admin_manual/configuration_files/file_sharing_configuration.rst index f75217851f7..c714986f092 100644 --- a/admin_manual/configuration_files/file_sharing_configuration.rst +++ b/admin_manual/configuration_files/file_sharing_configuration.rst @@ -100,8 +100,6 @@ forcing them. .. note:: There are more sharing options on config.php level available: `Configuration Parameters `_ -.. TODO ON RELEASE: Update version number above on release - .. _transfer_userfiles_label: Advanced settings @@ -178,8 +176,6 @@ reference.) Users may also transfer files or folders selectively by themselves. See `user documentation `_ for details. -.. TODO ON RELEASE: Update version number above on release - Creating persistent file Shares ------------------------------- diff --git a/admin_manual/configuration_user/two_factor-auth.rst b/admin_manual/configuration_user/two_factor-auth.rst index fcda7945797..02f14140c7d 100644 --- a/admin_manual/configuration_user/two_factor-auth.rst +++ b/admin_manual/configuration_user/two_factor-auth.rst @@ -43,15 +43,11 @@ types of factors. Three providers are automatically installed (but may need to b Other 2FA providers may be found in the App Store. -.. TODO ON RELEASE: Update version number above on release - .. figure:: ../images/2fa-app-install.png Developers can also `implement new two-factor provider apps `_. -.. TODO ON RELEASE: Update version number above on release - Enforcing two-factor authentication ----------------------------------- diff --git a/admin_manual/index.rst b/admin_manual/index.rst index a61b589e70e..c5c6f4ee994 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -39,5 +39,3 @@ respective manuals: .. _`Nextcloud User Manual`: https://docs.nextcloud.com/server/31/user_manual/en/ .. _`Nextcloud Desktop Client`: https://docs.nextcloud.com/desktop/latest/ - -.. TODO ON RELEASE: Update version number above on release diff --git a/admin_manual/installation/example_ubuntu.rst b/admin_manual/installation/example_ubuntu.rst index d36fec739bc..b0aa71bda98 100644 --- a/admin_manual/installation/example_ubuntu.rst +++ b/admin_manual/installation/example_ubuntu.rst @@ -16,8 +16,6 @@ following commands in a terminal:: If you are planning on running additional apps, keep in mind that they might require additional packages. See `Prerequisites for manual installation `_ for details. -.. TODO ON RELEASE: Update version number above on release - Now you need to create a database user and the database itself by using the MySQL command line interface. The database tables will be created by Nextcloud when you login for the first time. diff --git a/admin_manual/installation/harden_server.rst b/admin_manual/installation/harden_server.rst index b1272f4560d..51021bf21d3 100644 --- a/admin_manual/installation/harden_server.rst +++ b/admin_manual/installation/harden_server.rst @@ -306,8 +306,6 @@ Depending on your server setup, these are the possible connections: .. _optional (config): https://docs.nextcloud.com/server/31/admin_manual/configuration_server/config_sample_php_parameters.html#has-internet-connection .. _detailed field list: https://github.com/nextcloud/survey_client -.. TODO ON RELEASE: Update version number above on release - Setup fail2ban -------------- diff --git a/admin_manual/issues/general_troubleshooting.rst b/admin_manual/issues/general_troubleshooting.rst index 6121c127732..9f8e0022ed5 100644 --- a/admin_manual/issues/general_troubleshooting.rst +++ b/admin_manual/issues/general_troubleshooting.rst @@ -33,8 +33,6 @@ configuration report with the :ref:`occ config command .. _FAQ page: https://help.nextcloud.com/t/how-to-faq-wiki .. _bugtracker: https://docs.nextcloud.com/server/31/developer_manual/prologue/bugtracker/index.html -.. TODO ON RELEASE: Update version number above on release - General troubleshooting ----------------------- @@ -434,8 +432,6 @@ does not match the actual data stored in the user's ``data/$userId/files`` direc Metadata, versions, trashbin and encryption keys are not counted in the used space above. Please refer to the `quota documentation `_ for details. -.. TODO ON RELEASE: Update version number above on release - Running the following command can help fix the sizes and quota for a given user:: sudo -u www-data php occ files:scan -vvv diff --git a/admin_manual/occ_command.rst b/admin_manual/occ_command.rst index 936adb6fe14..a6f91394d3d 100644 --- a/admin_manual/occ_command.rst +++ b/admin_manual/occ_command.rst @@ -369,8 +369,6 @@ While setting a configuration value, multiple options are available: .. _Appconfig Concepts: https://docs.nextcloud.com/server/31/developer_manual/digging_deeper/config/appconfig.html#concept-overview -.. TODO ON RELEASE: Update version number above on release - You can list all configuration values with one command:: sudo -u www-data php occ config:list @@ -963,8 +961,6 @@ The command line option ``--transfer-incoming-shares`` overwrites the config.php Users may also transfer files or folders selectively by themselves. See `user documentation `_ for details. -.. TODO ON RELEASE: Update version number above on release - .. _occ_sharing_label: Files Sharing @@ -1040,8 +1036,6 @@ Verify your app:: When it returns nothing, your app is signed correctly. When it returns a message then there is an error. See `Code Signing `_ in the Developer manual for more detailed information. -.. TODO ON RELEASE: Update version number above on release - ``integrity:sign-core`` is for Nextcloud core developers only. See :doc:`../issues/code_signing` to learn more. diff --git a/admin_manual/webhook_listeners/index.rst b/admin_manual/webhook_listeners/index.rst index f583464622d..dc32b75ad3e 100644 --- a/admin_manual/webhook_listeners/index.rst +++ b/admin_manual/webhook_listeners/index.rst @@ -20,8 +20,6 @@ Listening to events You can use the OCS API to add webhooks for specific events: https://docs.nextcloud.com/31/latest/developer_manual/_static/openapi.html#/operations/webhook_listeners-webhooks-index -.. TODO ON RELEASE: Update version number above on release - Note: When authenticating with the OCS API to register webhooks the account you authenticate as must have administrator rights or delegated administrator rights. Filters diff --git a/admin_manual/windmill_workflows/index.rst b/admin_manual/windmill_workflows/index.rst index f76fb1034ea..8ec08f059b4 100644 --- a/admin_manual/windmill_workflows/index.rst +++ b/admin_manual/windmill_workflows/index.rst @@ -52,8 +52,6 @@ If you are not using the ExApp-packaged windmill install then you will have to r webhooks for your workflows manually via the webhook_listeners API: see https://docs.nextcloud.com/server/31/developer_manual/_static/openapi.html#/operations/webhook_listeners-webhooks-index -.. TODO ON RELEASE: Update version number above on release - The magic listener script ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/conf.py b/conf.py index 4c13d0c44a0..76f8dfe784b 100644 --- a/conf.py +++ b/conf.py @@ -25,6 +25,17 @@ # Can be overridden via DOCS_RELEASE env var (used for PDF builds to show the actual version number) release = os.environ.get('DOCS_RELEASE', version) +# Ensure release is either "latest", or a digit (for stable versions) +if not (release == 'latest' or release.isdigit()): + raise ValueError("Invalid release version: %s. Must be 'latest' or a digit." % release) + +# Print the version being built in a clear way in the logs +width = 60 +msg = " Building documentation for version: %s " % release +print("\n\n" + "#" * width) +print("#" + msg.center(width - 2, "#") + "#") +print("#" * width + "\n\n") + # RTD theme options html_theme_options = { 'logo_only': True, @@ -37,7 +48,18 @@ html_logo = "../_shared_assets/static/logo-white.png" # substitutions go here -rst_epilog = '.. |version| replace:: %s' % version +rst_epilog = """ +.. |version| replace:: %s +""" % (release) + +# Replace hardcoded /latest/ URLs in all .rst source files with the actual release +def replace_latest(app, docname, source): + if release != 'latest': + source[0] = source[0].replace('/server/latest/', '/server/%s/' % release) + +def setup(app): + app.connect('source-read', replace_latest) + # building the versions list version_start = 28 # THIS IS THE OLDEST SUPPORTED VERSION NUMBER diff --git a/developer_manual/basics/logging.rst b/developer_manual/basics/logging.rst index 935a419ff20..ae3908967a0 100644 --- a/developer_manual/basics/logging.rst +++ b/developer_manual/basics/logging.rst @@ -50,8 +50,6 @@ who changed the password of an item or made it public, the `admin audit log `_ is the correct place. -.. TODO ON RELEASE: Update version number above on release - You can easily add a log by simply emitting an ``OCP\Log\Audit\CriticalActionPerformedEvent`` event: .. code-block:: php diff --git a/developer_manual/basics/setting.rst b/developer_manual/basics/setting.rst index a7a2d1d9742..fb4b333754d 100644 --- a/developer_manual/basics/setting.rst +++ b/developer_manual/basics/setting.rst @@ -115,8 +115,6 @@ This is a feature that needs to be enabled for each admin setting class. To do so, the setting class needs to implement `IDelegatedSettings` instead of `ISettings` and implement two additional methods. -.. TODO ON RELEASE: Update version number above on release - .. code-block:: php `_. -.. TODO ON RELEASE: Update version number above on release - Create a new Federated Cloud Share ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst b/developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst index 56ec88e3eca..ef82d4a498b 100644 --- a/developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst +++ b/developer_manual/client_apis/OCS/ocs-taskprocessing-api.rst @@ -9,5 +9,3 @@ OCS TaskProcessing API The OCS Task processing API allows you to run task processing tasks, like prompting large language models implemented by apps using :ref:`the backend Task Processing API`. See the relevant `OpenAPI docs `_. - -.. TODO ON RELEASE: Update version number above on release diff --git a/developer_manual/exapp_development/faq/DockerSocketProxy.rst b/developer_manual/exapp_development/faq/DockerSocketProxy.rst index 19c7ef3f10c..37a8459875c 100644 --- a/developer_manual/exapp_development/faq/DockerSocketProxy.rst +++ b/developer_manual/exapp_development/faq/DockerSocketProxy.rst @@ -30,8 +30,6 @@ AppAPI automatically creates the default Deploy daemon configuration for Nextclo See `Nextcloud in Docker AIO (all-in-one) `_ for more details. -.. TODO ON RELEASE: Update version number above on release - .. note:: Nextcloud AIO is not limited to its default Deploy daemon. diff --git a/developer_manual/exapp_development/faq/Troubleshooting.rst b/developer_manual/exapp_development/faq/Troubleshooting.rst index c3d6afed860..54107c77292 100644 --- a/developer_manual/exapp_development/faq/Troubleshooting.rst +++ b/developer_manual/exapp_development/faq/Troubleshooting.rst @@ -30,8 +30,6 @@ ExApp deployment issues The deployment issues questions are covered in the `Test Deploy `_ section of the administration guide. Generally speaking, there are three steps to find the proper error message to understand the problem: -.. TODO ON RELEASE: Update version number above on release - 1. Check Nextcloud logs 2. Check ExApp container logs (available only if ExApp container is created and/or running) 3. Check Deploy daemon host logs (``journalctl -u docker.service``) diff --git a/developer_manual/exapp_development/tech_details/Translations.rst b/developer_manual/exapp_development/tech_details/Translations.rst index c70e51e3229..266f9321317 100644 --- a/developer_manual/exapp_development/tech_details/Translations.rst +++ b/developer_manual/exapp_development/tech_details/Translations.rst @@ -30,8 +30,6 @@ For the ``manual-install`` type, an administrator will have to manually extract (e.g. ``/path/to/apps-writable//l10n/*.(js|json)``). This will allow the server to access the ExApp's strings with translations. -.. TODO ON RELEASE: Update version number above on release - .. note:: Only the ``l10n`` folder must be present on the server side; ``appinfo/info.xml`` could lead to misdetection by the server as a PHP app folder. diff --git a/developer_manual/exapp_development/tech_details/api/logging.rst b/developer_manual/exapp_development/tech_details/api/logging.rst index 3044a22c325..fa32cf8c5a3 100644 --- a/developer_manual/exapp_development/tech_details/api/logging.rst +++ b/developer_manual/exapp_development/tech_details/api/logging.rst @@ -27,8 +27,6 @@ Request data The possible values of ``log_lvl`` are described here: `Nextcloud Log level `_ -.. TODO ON RELEASE: Update version number above on release - Response data ************* diff --git a/developer_manual/getting_started/devenv.rst b/developer_manual/getting_started/devenv.rst index 482b888571c..2fcdabaed7b 100644 --- a/developer_manual/getting_started/devenv.rst +++ b/developer_manual/getting_started/devenv.rst @@ -18,8 +18,6 @@ Set up Web server and database First `set up your Web server and database `_ (**Section**: Manual Installation - Prerequisites). -.. TODO ON RELEASE: Update version number above on release - Get the source -------------- @@ -28,8 +26,6 @@ There are two ways to obtain Nextcloud sources: * Using the `stable version `_ * Using the development version from `GitHub`_ which will be explained below. -.. TODO ON RELEASE: Update version number above on release - To check out the source from `GitHub`_ you will need to install Git (see `Setting up Git `_ from the GitHub help) Gather information about server setup diff --git a/user_manual/external_storage/external_storage.rst b/user_manual/external_storage/external_storage.rst index 8769d264df9..b84d93870da 100644 --- a/user_manual/external_storage/external_storage.rst +++ b/user_manual/external_storage/external_storage.rst @@ -8,5 +8,3 @@ in Nextcloud. Your Nextcloud server administrator controls which of these are available to you. Please see `Configuring External Storage (GUI) `_ in the Nextcloud Administrator's manual for configuration how-tos and examples. - -.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index 96509b8a806..30a71ab2b3f 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -239,8 +239,6 @@ Accessing files using macOS .. note:: The macOS Finder suffers from a `series of implementation problems `_ and should only be used if the Nextcloud server runs on **Apache** and **mod_php**, or **Nginx 1.3.8+**. Alternative macOS-compatible clients capable of accessing WebDAV shares include open source apps like `Cyberduck `_ (see instructions `here `_) and `Filezilla `_. Commercial clients include `Mountain Duck `_, `Forklift `_, `Transmit `_, and `Commander One `_. -.. TODO ON RELEASE: Update version number above on release - To access files through the macOS Finder: #. From the Finder's top menu bar, choose **Go > Connect to Server…**: diff --git a/user_manual/files/deleted_file_management.rst b/user_manual/files/deleted_file_management.rst index 19678dfec1a..da5a495e3ee 100644 --- a/user_manual/files/deleted_file_management.rst +++ b/user_manual/files/deleted_file_management.rst @@ -57,5 +57,3 @@ until the space limit is met again. .. note:: Your administrator may have configured the trash bin retention period to override the storage space management. See `admin documentation `_ for more details. - -.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/files/encrypting_files.rst b/user_manual/files/encrypting_files.rst index c82da652229..7f28309bf3d 100644 --- a/user_manual/files/encrypting_files.rst +++ b/user_manual/files/encrypting_files.rst @@ -37,8 +37,6 @@ The only way to disable encryption is to run the `"decrypt all" `_ script, which decrypts all files and disables encryption. -.. TODO ON RELEASE: Update version number above on release - Is it possible to disable encryption with the recovery key? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -46,8 +44,6 @@ Yes, *if* every user uses the `file recovery key `_, `"decrypt all" `_ will use it to decrypt all files. -.. TODO ON RELEASE: Update version number above on release - Can encryption be disabled without the user's password? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -56,8 +52,6 @@ If you don't have the users password or `file recovery key then there is no way to decrypt all files. What's more, running it on login would be dangerous, because you would most likely run into timeouts. -.. TODO ON RELEASE: Update version number above on release - Is it planned to move this to the next user login or a background job? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/user_manual/files/large_file_upload.rst b/user_manual/files/large_file_upload.rst index e15bbd884b7..7b9d7680ffd 100644 --- a/user_manual/files/large_file_upload.rst +++ b/user_manual/files/large_file_upload.rst @@ -11,5 +11,3 @@ Modifying certain Nextcloud variables requires administrative access. If you req * Refer to the section in the `Administration Documentation `_ that describes how to manage file upload size limits. - -.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/files/quota.rst b/user_manual/files/quota.rst index 96f509d63c2..e1629a56e0b 100644 --- a/user_manual/files/quota.rst +++ b/user_manual/files/quota.rst @@ -31,8 +31,6 @@ total is below 50%. .. note:: Your administrator may have configured the trash bin retention period to override the storage space management. See `administrator documentation `_ for more details. -.. TODO ON RELEASE: Update version number above on release - When version control is enabled, the older file versions are not counted against quotas. diff --git a/user_manual/files/sharing.rst b/user_manual/files/sharing.rst index 6c7b1aecb0e..02776f63b9d 100644 --- a/user_manual/files/sharing.rst +++ b/user_manual/files/sharing.rst @@ -14,8 +14,6 @@ Nextcloud users can share files and folders. Possible targets are: .. note:: Some options may not be available due to administrative configuration. See `administrator documentation `__ for details. -.. TODO ON RELEASE: Update version number above on release - Public link shares ------------------ diff --git a/user_manual/files/transfer_ownership.rst b/user_manual/files/transfer_ownership.rst index d23beaeba06..81a97d2a2e0 100644 --- a/user_manual/files/transfer_ownership.rst +++ b/user_manual/files/transfer_ownership.rst @@ -15,8 +15,6 @@ ownerships of those transferred files/folders will also be transferred. .. note:: The username autocompletion or listing may be limited due to administrative visibility configuration. See `administrator documentation `_ for details. -.. TODO ON RELEASE: Update version number above on release - #. The target user receives a notification where they are being asked whether to accept or reject the incoming transfer. diff --git a/user_manual/groupware/sync_gnome.rst b/user_manual/groupware/sync_gnome.rst index 3484551320e..93a4f50a5dd 100644 --- a/user_manual/groupware/sync_gnome.rst +++ b/user_manual/groupware/sync_gnome.rst @@ -17,8 +17,6 @@ This can be done by following these steps: `doesn't support Nextcloud's WebFlow login yet `_ (`Learn more `_): - .. TODO ON RELEASE: Update version number above on release - .. image:: ../images/goa-add-nextcloud-account.png #. In the next window, select which resources GNOME should access and diff --git a/user_manual/groupware/sync_ios.rst b/user_manual/groupware/sync_ios.rst index 202b94b5eea..a4a3941e64e 100644 --- a/user_manual/groupware/sync_ios.rst +++ b/user_manual/groupware/sync_ios.rst @@ -49,5 +49,3 @@ If it's still not working, have a look at `Troubleshooting Contacts & Calendar`_ .. _Troubleshooting Contacts & Calendar: https://docs.nextcloud.com/server/31/admin_manual/issues/general_troubleshooting.html#troubleshooting-contacts-calendar .. _Troubleshooting Service Discovery: https://docs.nextcloud.com/server/31/admin_manual/issues/general_troubleshooting.html#service-discovery - -.. TODO ON RELEASE: Update version number above on release diff --git a/user_manual/groupware/sync_kde.rst b/user_manual/groupware/sync_kde.rst index b53fd254735..ab0d7eba646 100644 --- a/user_manual/groupware/sync_kde.rst +++ b/user_manual/groupware/sync_kde.rst @@ -30,8 +30,6 @@ In KOrganizer and Kalendar: 3. Enter your username. As password, you need to generate an app-password/token (`Learn more `_): -.. TODO ON RELEASE: Update version number above on release - .. image:: ../images/korganizer_credentials.png 4. Choose ``Nextcloud`` as Groupware server option: