Encourage users to read tracks documentation#1568
Merged
pquentin merged 2 commits intoelastic:masterfrom Aug 30, 2022
Merged
Conversation
pquentin
added
:Docs
dliappis
suggested changes
Aug 29, 2022
Contributor
dliappis
left a comment
dliappis
left a comment
There was a problem hiding this comment.
Left a small nit-y comment.
docs/faq.rst
Outdated
| --------------------------------------------- | ||
|
|
||
| Rally comes with a set of tracks out of the box which we maintain in the `rally-tracks repository on Github <https://github.com/elastic/rally-tracks>`_. This repository contains the track descriptions. The actual data are stored as compressed files in an S3 bucket. | ||
| Rally comes with a set of tracks out of the box which we maintain in the `rally-tracks repository on Github <https://github.com/elastic/rally-tracks>`_. This repository contains the track descriptions. The actual data are stored as compressed files in an S3 bucket. Each track is documented in README files, including parameters and example data. |
Contributor
There was a problem hiding this comment.
are stored as compress files in an S3 bucket.
This is no longer true (some time now). They are on GCS and served via a CDN/proxy.
I think this is a detail that doesn't matter, and could always change. What if instead we say: as compressed files in a cloud bucket.
We're using GCS and a proxy now, but it's an implementation detail.
dliappis
approved these changes
Aug 30, 2022
| ------------------------------ | ||
|
|
||
| So far the track is only available on your local machine. To share your track you could check it into version control. To avoid committing the potentially huge data file you can expose it via http (e.g. via an S3 bucket) and reference it in your track with the property ``base-url``. Rally expects that the URL points to the parent path and appends the document file name automatically. | ||
| So far the track is only available on your local machine. To share your track you could check it into version control. To avoid committing the potentially huge data file you can expose it via HTTP (e.g. via a cloud bucket) and reference it in your track with the property ``base-url``. Rally expects that the URL points to the parent path and appends the document file name automatically. |
Contributor
There was a problem hiding this comment.
nit: as we support http and https maybe we should encourage https in this day and age?
Member
Author
There was a problem hiding this comment.
We have many occurrences of "HTTP" in the codebase and the docs, I don't see it as referring specifically to plain text traffic
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This addresses the following user feedback: