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

Consolidate and improve track/team repo revision logic docs #1265

Conversation

dliappis
Copy link
Contributor

Currently the repository version matching logic for Rally tracks/teams
is duplicated in Rally docs as well as README files in in our standard
tracks/teams repositories.

Update docs consolidating existing documentation from
elastic/rally-tracks and elastic/rally-teams

Relates:

Currently the repository version matching logic for Rally tracks/teams
is duplicated in Rally docs as well as README files in in our standard
tracks/teams repositories.

Update docs consolidating existing documentation from
elastic/rally-tracks and elastic/rally-teams

Relates:

- elastic/rally-tracks#162
- elastic/rally-teams#62
@dliappis dliappis added :Docs Changes to the documentation cleanup Linter changes, reformatting, removal of unused code etc. labels May 12, 2021
@dliappis dliappis added this to the 2.2.1 milestone May 12, 2021
@dliappis dliappis self-assigned this May 12, 2021
dliappis added a commit to dliappis/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes elastic#162
dliappis added a commit to dliappis/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes elastic#62
Copy link
Member

@danielmitterdorfer danielmitterdorfer left a comment

Choose a reason for hiding this comment

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

LGTM, I left one nit but no need for another review round.

docs/track.rst Outdated

Assuming the track repository has several branches, the order is:
#. *Exact match major.minor.patch-extension_label* (e.g. ``7.0.0-beta1``)
Copy link
Member

Choose a reason for hiding this comment

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

Nit: A few lines above in MAJOR.MINOR.PATCH-SUFFIX we call this SUFFIX but here we call it extension_label. We should align the names.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. Fixed in 3a4ca08

@dliappis dliappis merged commit c1bba05 into elastic:master May 12, 2021
@dliappis dliappis deleted the consolidate-track-team-repository-version-scheme-logic-docs branch May 12, 2021 12:10
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-tracks that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #162
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
dliappis added a commit to elastic/rally-teams that referenced this pull request May 12, 2021
With elastic/rally#1265 the official Rally docs
should be the point of reference on how the versioning scheme works.

Remove versioning scheme docs duplication and reference the official
docs.

Closes #62
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Linter changes, reformatting, removal of unused code etc. :Docs Changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants