nextcloud / nextcloud/documentation

RFC: Usage of versionadded for groupware apps

Open
#13,813 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

We currently use versionadded for the groupware apps. However, most users don't know the exact version of Mail they're using, though they usually know their Nextcloud version.

Idea: When using versionadded for groupware apps, we could also list the supported Nextcloud versions alongside the app version. This would make it easier for users to understand compatibility.

Example:

Image

Source:

.. versionadded:: 5.7 Nextcloud 31 or newer

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing existing versionadded directives for the groupware apps and the surrounding documentation conventions; the issue names no specific files or tests. Compare the app-version entries with the supported Nextcloud versions, then confirm the intended convention and update the affected documentation consistently once the RFC is resolved.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.