Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document all configuration options available in acre.yaml #29

Open
Diaphteiros opened this issue May 16, 2019 · 3 comments
Open

document all configuration options available in acre.yaml #29

Diaphteiros opened this issue May 16, 2019 · 3 comments
Assignees
Labels
area/documentation Documentation related kind/enhancement Enhancement, improvement, extension lifecycle/rotten Nobody worked on this for 12 months (final aging stage)

Comments

@Diaphteiros
Copy link
Contributor

The user has to provide an acre.yaml file containing the configuration. Most relevant parts are documented here. However, some components support additional options or specific edge cases that require further configuration - which is partly not documented at all.

To not overstrain new users with a huge README, these features and their corresponding configuration options should be documented in an extra document (or multiple documents).

Structure of the documentation can be discussed here.

@Diaphteiros
Copy link
Contributor Author

It is probably a good idea to document this feature-wise, meaning each feature gets its own documentation page, also containing the information on how to configure it in the acre.yaml.

Documenting the acre.yaml with all configuration options and what they do in one single file (like it is in the README linked above) is likely going to result in an extremely long and hard-to-understand file.

@gardener-robot-ci-1 gardener-robot-ci-1 added lifecycle/stale Nobody worked on this for 6 months (will further age) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels Jul 15, 2019
@Diaphteiros Diaphteiros self-assigned this Jul 23, 2019
@Diaphteiros
Copy link
Contributor Author

Several "hidden" configuration options have been documented by now. You can see an overview here: https://github.com/gardener/garden-setup/blob/master/docs/extended/index.md

However, some are still missing, e.g. the connectors option for identity. The extended configuration index linked above could also be improved.

@Diaphteiros Diaphteiros added area/documentation Documentation related kind/enhancement Enhancement, improvement, extension labels Jul 23, 2019
@gardener-robot-ci-1 gardener-robot-ci-1 added lifecycle/stale Nobody worked on this for 6 months (will further age) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels Sep 22, 2019
@ghost ghost added lifecycle/stale Nobody worked on this for 6 months (will further age) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels Nov 22, 2019
@ghost ghost added lifecycle/stale Nobody worked on this for 6 months (will further age) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels Jan 22, 2020
@ghost ghost added the lifecycle/stale Nobody worked on this for 6 months (will further age) label Mar 23, 2020
@ghost ghost added lifecycle/rotten Nobody worked on this for 12 months (final aging stage) and removed lifecycle/stale Nobody worked on this for 6 months (will further age) labels May 23, 2020
@Diaphteiros
Copy link
Contributor Author

I think the only big thing that is missing is the documentation for landscape.versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related kind/enhancement Enhancement, improvement, extension lifecycle/rotten Nobody worked on this for 12 months (final aging stage)
Projects
None yet
Development

No branches or pull requests

2 participants