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

Cherry-pick #17694 to 7.x: [Heartbeat][Docs] Consistently use id/name in all examples #17697

Merged
merged 1 commit into from
Apr 15, 2020

Conversation

andrewvc
Copy link
Contributor

@andrewvc andrewvc commented Apr 14, 2020

Cherry-pick of PR #17694 to 7.x branch. Original message:

We should always include these optional config values, as not using them creates continuity issues in the Uptime app. The id attribute is the only way we can consistently identify a monitor over time when its config changes, and the name attribute is used for display purposes in the Uptime app.

This change makes our docs examples reflect best practices.

…7694)

We should always include these optional config values, as not using them
creates continuity issues in the Uptime app. The `id` attribute is the
only way we can consistently identify a monitor over time when its
config changes, and the `name` attribute is used for display purposes in
the Uptime app.

This change makes our docs examples reflect best practices.

(cherry picked from commit 4bb189d)
@andrewvc andrewvc requested a review from a team as a code owner April 14, 2020 09:25
@andrewvc andrewvc added backport review Team:obs-ds-hosted-services Label for the Observability Hosted Services team Heartbeat labels Apr 14, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/uptime (:uptime)

@andrewvc andrewvc added the docs label Apr 14, 2020
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM

@andrewvc andrewvc merged commit a6350ee into elastic:7.x Apr 15, 2020
@andrewvc andrewvc deleted the backport_17694_7.x branch April 15, 2020 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport docs Heartbeat review Team:obs-ds-hosted-services Label for the Observability Hosted Services team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants