Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

[all] Simplify doc in 7.9 branch #859

Merged
merged 2 commits into from
Oct 21, 2020

Conversation

nkammah
Copy link
Contributor

@nkammah nkammah commented Oct 21, 2020

Reword warning statements in chart readme to streamline the release process - related PR : #858

@nkammah nkammah requested a review from jmlrt October 21, 2020 11:16
@nkammah nkammah force-pushed the reword-warning-statements-in-readme branch from 45f8f9e to eef9409 Compare October 21, 2020 11:17
@nkammah nkammah changed the title Reword warning statements in chart readme [all] Simplify doc in 7.9 branch Oct 21, 2020
Copy link
Member

@jmlrt jmlrt left a comment

Choose a reason for hiding this comment

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

LGTM⛴ just one comment to make release automation easier

Comment on lines 11 to 12
**Warning**: This branch is used for development, please use the latest [7.9](https://github.com/elastic/helm-charts/releases)
release for released version.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe keeping this statement in a single line would make easier to automate removing it during release and adding it back after releases

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The intent with that PR is that we will not add/remove that warning statement for / after the release. Do you foresee this being an issue?

Copy link
Member

Choose a reason for hiding this comment

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

Yes this is an issue because this statement will be displayed in Artifact Hub and will make user think that released charts are for development.

@@ -8,8 +8,8 @@ The design and code is less mature than official GA features and is being
provided as-is with no warranties. Alpha features are not subject to the support
SLA of official GA features (see [supported configurations][] for more details).

**Warning**: This branch is used for development, please use [7.9.2][https://github.com/elastic/helm-charts/releases/tag/7.9.2] release for released version.

**Warning**: This branch is used for development, please use the latest [7.9](https://github.com/elastic/helm-charts/releases)
Copy link
Member

Choose a reason for hiding this comment

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

Another comment, maybe we could mention 7.x instead 7.9 see #860 (comment)

@nkammah nkammah merged commit efdeec8 into elastic:7.9 Oct 21, 2020
@nkammah nkammah deleted the reword-warning-statements-in-readme branch October 21, 2020 15:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants