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

Add warning comment placeholder (7.9 branch) #884

Merged
merged 2 commits into from
Nov 5, 2020
Merged

Add warning comment placeholder (7.9 branch) #884

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
151050b
Add a development warning comment to help with release automation.
nkammah Nov 3, 2020
ad10624
Rephrase and add a line break to waring placeholder
nkammah Nov 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion apm-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +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 the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] 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. 

<!-- development warning placeholder -->
**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

I have 2 suggestions:

  • maybe add "placeholder" in the markdown comment to make it more explicit what it is, especially when the warning is removed in released version
  • maybe move placeholder comment and warning statements on different lines to fix the markdown format issue


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down
3 changes: 2 additions & 1 deletion elasticsearch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This Helm chart is a lightweight way to configure and run our official
[Elasticsearch Docker image][].

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down
3 changes: 2 additions & 1 deletion filebeat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This Helm chart is a lightweight way to configure and run our official
[Filebeat Docker image][].

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down
3 changes: 2 additions & 1 deletion kibana/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This Helm chart is a lightweight way to configure and run our official
[Kibana Docker image][].

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down
3 changes: 2 additions & 1 deletion logstash/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +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 the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down
3 changes: 2 additions & 1 deletion metricbeat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This Helm chart is a lightweight way to configure and run our official
[Metricbeat Docker image][].

**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.
<!-- development warning -->**Warning**: This branch is used for development, please use the latest [7.x][] release for released version.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Expand Down