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

Improve documentation of track repo URL #459

Merged
merged 2 commits into from
Apr 6, 2018
Merged

Improve documentation of track repo URL #459

merged 2 commits into from
Apr 6, 2018

Conversation

danielmitterdorfer
Copy link
Member

Closes #443

@danielmitterdorfer danielmitterdorfer added enhancement Improves the status quo :Docs Changes to the documentation labels Apr 5, 2018
@danielmitterdorfer danielmitterdorfer added this to the 0.10.0 milestone Apr 5, 2018
dliappis
dliappis approved these changes Apr 5, 2018
View reviewed changes
Copy link
Contributor

@dliappis dliappis left a comment

Choose a reason for hiding this comment

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

LGTM, left a minor comment.

docs/track.rst Outdated
@@ -70,7 +70,7 @@ If you have added a remote you should also add it in ``~/.rally/rally.ini``, oth

private.url = <<URL_TO_YOUR_ORIGIN>>

Rally will then automatically update the local tracking branches before the benchmark starts.
If you specify ``--track-repository=private``, Rally will check whether there is a directory ``~/.rally/benchmarks/tracks/private``. If there is none, it will use the provided URL to clone the repo. However, if the directory already exists the property is irrelevant and Rally will just update the local tracking branches before the benchmark starts.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe replace if the directory already exists the property is irrelevant with if the directory already exists, the property gets ignored

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the suggestion; makes sense to me. I'll change the wording before merging.

@danielmitterdorfer danielmitterdorfer merged commit 05a2793 into elastic:master Apr 6, 2018
@danielmitterdorfer danielmitterdorfer deleted the enhance-track-repo-docs branch April 6, 2018 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dliappis dliappis dliappis approved these changes

Assignees
No one assigned
Labels
:Docs Changes to the documentation enhancement Improves the status quo
Projects
None yet
Milestone
0.10.0
Development

Successfully merging this pull request may close these issues.
2 participants
@danielmitterdorfer @dliappis