Improve documentation in various ways #1326
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In this commit, I use "virtual environment" to refer to either virtualenv or venv.
pquentin
added
:Docs
DJRickyB
reviewed
Sep 9, 2021
docs/install.rst
Outdated
| @@ -112,7 +112,7 @@ To find the JDK, Rally expects the environment variable ``JAVA_HOME`` to be set | |||
| Optional dependencies | |||
| --------------------- | |||
|
|
|||
| S3 support is optional and can be installed using the ``s3`` extra. If you need S3 support, install ``esrally[s3]`` instead of just ``esrally``, but other than that follow the instructions below. | |||
| S3 support is optional and can be installed using the ``esrally[s3]`` instead of just ``esrally``, but other than that follow the instructions below. | |||
There was a problem hiding this comment.
imo this becomes less clear now, specifically the phrase using ... esrally[s3] instead of just esrally, and I'd prefer to revert 4fdcfef
This reverts commit 4fdcfef. The result is less clear.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I'm making progress through the docs, I'm seeing various little things that can be improved. Since you may not agree about all this, I split it into multiple commits to make it easy to cut things out.