nextcloud / nextcloud/documentation

Coverage of config parameter/value storage for app and core developers

Open
#12,475 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop enhancement feature: apps management feature: settings manual: developer nice to have
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

I think this would be some useful information to compile for app as well as core developers.

Not just solely for documentation purposes, but from a systems design perspective.

Potential content coverage (eventually, not necessarily initially):

  • When to use each type (other than user):
    • config/config.php
      • i.e. when required for (during) initial installation (but not post-install configuration matters); when required to be available to the built-in Updater
    • system config values
    • system core config values
    • app config values
    • user-level values (i.e. specific to admins)
  • Special policies (if any)
    • re: config/config.php
      • i.e. usage by non-shipped apps
    • Exceptions
      • Grandfathering (For Now)
      • Grandfathering (For Reasons)
  • How-to:
    • Document
    • Deprecate
    • Migrate

That said, currently I'd probably label this:

  • nice to have
  • future tech debt

So still probably low priority (unless someone just finds themselves really compelled to jump on it of course).

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 inventorying the configuration locations named in the issue, including config/config.php, system config values, system core config values, app config values, and user-level values. Define the intended documentation scope for usage, special policies, exceptions, and how to document, deprecate, and migrate settings. Done means these choices and procedures are clearly documented for app and core developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.