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.

Sign up for GitHub

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

Jump to bottom

Add config reference documentation #991

Closed
danielmitterdorfer opened this issue May 11, 2020 · 0 comments · Fixed by #1137
Closed

Add config reference documentation #991

danielmitterdorfer opened this issue May 11, 2020 · 0 comments · Fixed by #1137
Assignees
@danielmitterdorfer
Labels
:Docs Changes to the documentation enhancement Improves the status quo
Milestone
2.x

Comments

@danielmitterdorfer
Copy link
Member

We currently document how users can customize Rally with the config subcommand in https://esrally.readthedocs.io/en/stable/configuration.html. However, we are missing a reference documentation where we can also document settings that can be specified manually, e.g. probing.url (introduced in #909).

Note: Use git grep "opts.*mandatory=False" to find these settings (will return a few false positives though).
@danielmitterdorfer danielmitterdorfer added enhancement Improves the status quo :Docs Changes to the documentation labels May 11, 2020
@danielmitterdorfer danielmitterdorfer added this to the 2.x milestone May 11, 2020
@danielmitterdorfer danielmitterdorfer mentioned this issue May 28, 2020
Merged
danielmitterdorfer added a commit to danielmitterdorfer/rally that referenced this issue Dec 16, 2020
@danielmitterdorfer
Add a configuration file reference
5977568 
With this commit we add reference docs for Rally's configuration file
`rally.ini`. We also move one configuration property from the `system`
to the `reporting` section as it is more appropriate there.

We intentionally placed this information on the existing configuration
page instead of creating a new one. We did this to provide continuity in
the future because we intend to remove the dedicated `configure`
subcommand and instead rely on users editing the configuration file
directly. When we remove this functionality, we can also remove obsolete
sections from this page and move it to the reference documentation.

Closes elastic#991
@danielmitterdorfer danielmitterdorfer mentioned this issue Dec 16, 2020
Merged
@danielmitterdorfer danielmitterdorfer self-assigned this Dec 17, 2020
danielmitterdorfer added a commit that referenced this issue Dec 17, 2020
@danielmitterdorfer
Add a configuration file reference (#1137)
b3a0e15 
With this commit we add reference docs for Rally's configuration file
`rally.ini`. We also move one configuration property from the `system`
to the `reporting` section as it is more appropriate there.

We intentionally placed this information on the existing configuration
page instead of creating a new one. We did this to provide continuity in
the future because we intend to remove the dedicated `configure`
subcommand and instead rely on users editing the configuration file
directly. When we remove this functionality, we can also remove obsolete
sections from this page and move it to the reference documentation.

Closes #991
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danielmitterdorfer danielmitterdorfer

Labels
:Docs Changes to the documentation enhancement Improves the status quo
Projects
None yet
Milestone
2.x
Development

Successfully merging a pull request may close this issue.

Add a configuration file reference danielmitterdorfer/rally
1 participant
@danielmitterdorfer