nixos/nextcloud: add basic module documentation and warn about current upgrading issues #51053
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @flokli would you mind having a look? |
Ekleog
requested changes
Nov 26, 2018
flokli
reviewed
Nov 26, 2018
Ma27
force-pushed
the
draft-nextcloud-module-docs
branch
from
64524f8
to
cf56ac2
Compare
Ekleog
approved these changes
Nov 27, 2018
iimog
reviewed
Nov 29, 2018
…t upgrading issues Part of NixOS#49783. NextCloud tracks in its `config.php` the application's state which makes it hard for the module to modify configurations during upgrades. It will take time until the issue is properly fixed, therefore we decided to warn about this in the manual. This PR addresses two things: * Adding a basic example for nextcloud. I figured it to be helpful to add some basic usage instructions when adding a new manual entry. Advanced documentation may follow later. For now this document actively links to the service options, so users are guided to the remaining options that can be helpful in certain cases. * Add a warning about upgrades and manual changes in `/var/lib/nextcloud`. This will be fixed in the future, but it's definetely helpful to document the current issues in the manual (as proposed in NixOS#49783 (comment)).
Ma27
force-pushed
the
draft-nextcloud-module-docs
branch
from
cf56ac2
to
216a954
Compare
globin
reviewed
Nov 29, 2018
10 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
Part of #49783. NextCloud tracks in its
config.phpthe application'sstate which makes it hard for the module to modify configurations during
upgrades.
It will take time until the issue is properly fixed, therefore we
decided to warn about this in the manual.
This PR addresses two things:
Adding a basic example for nextcloud. I figured it to be helpful to
add some basic usage instructions when adding a new manual entry.
Advanced documentation may follow later.
For now this document actively links to the service options, so users
are guided to the remaining options that can be helpful in certain
cases.
Add a warning about upgrades and manual changes in
/var/lib/nextcloud. This will be fixed in the future, but it'sdefinetely helpful to document the current issues in the manual (as
proposed in nextcloud module: changing config doesn't propagate to the module #49783 (comment)).
Things done
sandboxinnix.confon non-NixOS)nix-shell -p nox --run "nox-review wip"./result/bin/)nix path-info -Sbefore and after)