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

Provide better example configuration in repo #3835

Open
simonswine opened this issue Jan 13, 2025 · 1 comment
Open

Provide better example configuration in repo #3835

simonswine opened this issue Jan 13, 2025 · 1 comment
Labels
good first issue Good for newcomers help wanted type/docs Improvements for doc docs. Used by Docs team for project management

Comments

@simonswine
Copy link
Contributor

I think we should provide a better example config file in ./cmd/pyroscope/pyroscope.yaml.

The configuration page in our docs seem to be tricky to understand, as they use a "reference name" for certain sections, which often is confused by users. (example 1, example 2)

All the options should be commented out, ideally generated from the existing structs.

@simonswine simonswine added type/docs Improvements for doc docs. Used by Docs team for project management help wanted good first issue Good for newcomers labels Jan 13, 2025
@marcsanmi
Copy link
Contributor

We should check other products when updating the documentation, as they use a similar structure (e.g. Loki's configuration)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

No branches or pull requests

2 participants