nextcloud / nextcloud/shareimporter

Add README

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop documentation high
Dominant language
PHP
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Add README to explain:

  1. how to configure (what settings)
  2. how it works: it looks like it would not only import shares/storage configs but also delete them if the remote web service doesn't contain the share any more in its list (which means an admin cannot use this together with manually configured non-app-managed storages as they'd get deleted upon the next login)

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 repository's configuration and login-time import behavior, including how the remote web service's share list is handled. Add a README covering the required settings and explaining that shares absent from the remote list may be deleted, including the incompatibility with manually configured non-app-managed storages.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.