nextcloud / nextcloud/documentation

versioning documentation confusing and incomplete

Open
#1,141 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop enhancement feature: versions good first issue manual: admin manual: user
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

Currently the user manual (as well as the admin guide) does not give a user unfamiliar with versioning a clear indication of the features and their uses. Much of the discussion relates to automatic deletion of saved versions, without any explanation of how and when versions are created.

Questions that should be addressed are:

  1. When are new versions created? Is it automatic or manual? Is every edit and upload a new version?
  2. Can versions be accessed by or managed by a client?

For example, the text "Versioning creates backups of files" could read, "The previous version of any file in a Nextcloud server is saved every time it is edited on the server or uploaded by a client". That is, assuming I understand the facts correctly. Otherwise, the actual behavior would need to be clarified. I feel that I ought to understand at least that much after reading the manual.

See the forum discussion I opened earlier.

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 with the versioning sections of the user manual and admin guide, then review the linked forum discussion for context. Verify when versions are created and whether clients can access or manage them. Done means both guides clearly explain version creation, access, management, and the limits of the backup wording.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.