nextcloud / nextcloud/documentation

Undocumented supported apps

Open
#11,713 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Some supported apps lack documentation of any sort in the Admin Manual.

  • Circles
  • Collaborative tags
  • First Run Wizard
  • Full text search
  • Group folders
  • Guests
  • Monitoring
  • Announcements
  • Notifications
  • Photos
  • Recommendations
  • Related resources
  • SharePoint Backend
  • Suspicious Login
  • SSO & SAML authentication
  • Social sharing
  • Terms of service
  • Two-Factor backup codes
  • Two-Factor WebAuthn (replaces U2F)
  • Talk
  • ONLYOFFICE
  • Global Site Selector
  • Mail

The above should probably each have at a minimum:

  • a brief page/section under Configuration (or elsewhere if more appropriate)
  • a section in the occ commands chapter (where applicable)

The following don't have much (if any) in the way of admin facing settings/commands, but a brief paragraph mentioning them in the Admin Manual seems appropriate (since they're supported and/or shipped apps). At a minimum describing "What this app does":

  • Deck
  • Comments
  • Contacts Interaction - https://github.com/nextcloud/server/pull/19075
  • Data Request
  • Nextcloud Announcements
  • PDF Viewer
  • Share by Mail
  • Calendar (distinct from CalDAV)
  • Contacts (distinct from CardDAV)
  • Lookup Server Connector

TODO:

  • Create dedicated issues for each of the above apps and edit this issue with links to them

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 the Admin Manual's Configuration and occ commands chapters, then compare the listed supported apps with existing coverage. Split the work into dedicated issues as requested, documenting each app's purpose and, where applicable, its settings and occ commands. Done means the apps have appropriate Admin Manual coverage and this issue links the follow-up issues.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.