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

Remove example configuration from docs #377

Merged
merged 1 commit into from
Sep 28, 2021

Conversation

lippserd
Copy link
Member

@lippserd lippserd commented Sep 28, 2021

We already have config.yml.example as a source to copy and paste
so one can get started easily. In addition,
only one place has to be maintained for the example configuration.

This PR should be merged before #366.

@cla-bot cla-bot bot added the cla/signed label Sep 28, 2021
@lippserd lippserd added this to the v1.0.0-rc2 milestone Sep 28, 2021
@lippserd lippserd mentioned this pull request Sep 28, 2021
1 task
@lippserd lippserd requested a review from Al2Klimov September 28, 2021 13:45
Copy link
Member

@Al2Klimov Al2Klimov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section names are missing in the docs (other construction area), so at least a link to the example config (we decided to keep #375) would be helpful.

@lippserd
Copy link
Member Author

Section names are missing in the docs (other construction area), so at least a link to the example config (we decided to keep #375) would be helpful.

Makes sense.

We already have config.yml.example as a source to copy and paste
so one can get started easily. In addition,
only one place has to be maintained for the example configuration.
@lippserd lippserd force-pushed the remove-example-config-from-docs branch from d7491cd to 74e5da9 Compare September 28, 2021 14:19
@lippserd lippserd requested a review from Al2Klimov September 28, 2021 14:22
@lippserd lippserd merged commit 749bca9 into master Sep 28, 2021
@lippserd lippserd deleted the remove-example-config-from-docs branch September 28, 2021 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants