nextcloud / nextcloud/calendar_resource_management

Lacks documentation about CLI arguments

Open Beginner friendly
#96 1 comment 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop bug documentation
Dominant language
PHP
Stars
76
Forks
17
Avg merge
1h 50m
Merged PRs (30d)
15

Description

Steps to reproduce

Arguments for CLI creation are unclear (to me at least…)

For example, for room creation :

  • story_id self-explenatory
  • uid is it an uid of an existing user (owner of resource ?) or a new id ?
  • display_name self-explenatory
  • email mention that it is a « fake » email, acting like a unique-identifier
  • room_type Is it supposed to exist with same label ? Which category can be picked ?
Expected behavior

doc

Actual behavior

no doc :)

App version

No response

Additional info

No response

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 locating the documentation or CLI entry point for room creation and review how story_id, uid, display_name, email, and room_type are described or handled. Document what uid and room_type mean, and note that email acts as a unique identifier rather than a real address. Done means the CLI arguments and their accepted values are understandable without additional context.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.