chore(nextcloud): switch to helm-docs #633
Draft
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
Signed-off-by: WrenIX <dev.github@wrenix.eu>
Signed-off-by: WrenIX <dev.github@wrenix.eu>
wrenix
force-pushed
the
fix/helm-docs
branch
from
20522d5
to
939481a
Compare
Signed-off-by: WrenIX <dev.github@wrenix.eu>
wrenix
force-pushed
the
fix/helm-docs
branch
2 times, most recently
from
988c3d5
to
0b88621
Compare
Signed-off-by: WrenIX <dev.github@wrenix.eu>
wrenix
force-pushed
the
fix/helm-docs
branch
from
0b88621
to
9674ee3
Compare
jessebot
reviewed
Sep 24, 2024
jessebot
reviewed
Sep 24, 2024
jessebot
reviewed
Sep 24, 2024
Comment on lines
-207
to
-214
| ### Database Configurations | ||
| By default, nextcloud will use a SQLite database. This is not recommended for production, but is enabled by default for testing purposes. When you are done testing, please set `internalDatabase.enabled` to `false`, and configure the `externalDatabase` parameters below. | ||
|
|
||
| For convenience, we packages the following Bitnami charts for databases (feel free to choose _one_ below): | ||
| - [Bitnami MariaDB chart](https://github.com/bitnami/charts/tree/main/bitnami/mariadb) | ||
| - [Bitnami PostgreSQL chart](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) | ||
|
|
||
| If you choose to use one of the prepackaged Bitnami helm charts, you must configure both the `externalDatabase` parameters, and the parameters for the chart you choose. For instance, if you choose to use the Bitnami PostgreSQL chart that we've prepackaged, you need to also configure all the parameters for `postgresql`. You do not need to use the Bitnami helm charts. If you want to use an already configured database that you have externally, just set `internalDatabase.enabled` to `false`, and configure the `externalDatabase` parameters below. |
There was a problem hiding this comment.
so right now, I'd worry about losing stuff like this specifically, unless we want to truly separate our docs into it's own wiki or perhaps a doc site? 🤔
There was a problem hiding this comment.
Agreed, we lose a lot of the current docs from the README
There was a problem hiding this comment.
I'm open to using the built in github wiki feature, or playing with the helm-docs templates to make sure we keep these docs, as they help out the users a lot when searching this repo.
There was a problem hiding this comment.
I would try to avoid splitting the docs across multiple places (e.g. README and wiki)
There was a problem hiding this comment.
Ahm, of course that I mean with todo:
add extra documentations on the README helm-docs template :)
Co-authored-by: Jesse Hitch <jessebot@linux.com> Signed-off-by: WrenIX <133280015+wrenix@users.noreply.github.com>
4 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.
Description of the change
use helm-docs for documentation
Benefits
No duplicated documentation between README and values.yaml
Possible drawbacks
Not yet so good structed as before, TODOs are:
values.yamla usefull documentationApplicable issues
fixes #547
Additional information
Readme rendered
Checklist
Chart.yamlaccording to semver.