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

[Heartbeat][Docs] Consistently use id/name in all examples #17694

Merged
merged 1 commit into from
Apr 14, 2020

Conversation

andrewvc
Copy link
Contributor

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.

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.
@andrewvc andrewvc added docs [zube]: In Review Team:obs-ds-hosted-services Label for the Observability Hosted Services team labels Apr 14, 2020
@andrewvc andrewvc requested a review from dedemorton April 14, 2020 02:04
@andrewvc andrewvc requested a review from a team as a code owner April 14, 2020 02:04
@andrewvc andrewvc self-assigned this Apr 14, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/uptime (:uptime)

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 4bb189d into elastic:master Apr 14, 2020
@andrewvc andrewvc deleted the use-id-in-docs branch April 14, 2020 09:19
andrewvc added a commit to andrewvc/beats that referenced this pull request Apr 14, 2020
…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 added a commit to andrewvc/beats that referenced this pull request Apr 14, 2020
…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 added a commit that referenced this pull request Apr 15, 2020
…17698)

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 added a commit that referenced this pull request Apr 15, 2020
…17697)

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)
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…7694) (elastic#17698)

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 59bf972)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:obs-ds-hosted-services Label for the Observability Hosted Services team v7.7.0 v7.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants