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

[DOCS] Qualified Watcher topics to distinguish from Kib Alerting #65908

Merged
merged 19 commits into from
Dec 8, 2020

Conversation

debadair
Copy link
Contributor

@debadair debadair commented Dec 5, 2020

With the introduction of Kibana Alerting, using Alerting in the Watcher docs is confusing, as are the unqualified actions that overlap. The overlap also has SEO implications that make it less likely for folks to find the Kibana Alerting docs.

This PR qualifies the Watcher headings and anchors that generate the HTML page names, adds the old pages to the redirects file, and updates the necessary xrefs.

@jrodewig
Copy link
Contributor

jrodewig commented Dec 7, 2020

I wonder if simply changing the headings here would suffice.

Changing anchors requires a ton of overhead and creates an awful experience for users with the old URL. While I know the URL impacts SEO, I don't think the marginal SEO gains are worth the friction for users.

@debadair
Copy link
Contributor Author

debadair commented Dec 7, 2020

@elasticmachine retest this please

@debadair
Copy link
Contributor Author

debadair commented Dec 8, 2020

I had to revert some of the anchor changes, so ended up reverting all of them. It means that these pages are still possibly more likely to surface in search results than the Kibana Alerting pages, but the heading changes should help clarify things and this way it isn't as disruptive for folks who are using Watcher.

@debadair debadair marked this pull request as ready for review December 8, 2020 00:58
@elasticmachine elasticmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Dec 8, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. However, I think we may be missing a redirect for one remaining anchor change.

@@ -1,6 +1,9 @@
[role="xpack"]
[[trigger]]
== Triggers
[[triggers]]
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this anchor change was intentional. If so, we should add a redirect for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll revert that one, too.

@@ -1,6 +1,9 @@
[role="xpack"]
[[actions-email]]
=== Email action
=== Watcher email action
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use the attribute here?

Suggested change
=== Watcher email action
=== {watcher} email action

x-pack/docs/en/watcher/actions/index.asciidoc Outdated Show resolved Hide resolved
Comment on lines 1 to 3
[role="xpack"]
[[xpack-alerting]]
= Alerting on cluster and index events
[[watcher-alerting]]
= Watching for cluster and index events
Copy link
Contributor

Choose a reason for hiding this comment

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

This file looks inert. Maybe remove it entirely?

Also not sure why this isn't just Watch for...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will remove it. It's an artifact from when we built standalone getting started "books" for the translation effort.

@@ -205,7 +205,7 @@ October 28, 2015
use the following index name `<logstash-{now/d{YYYY.MM.dd|+01:00}}>`.

.New Features
* Added new <<actions-hipchat,HipChat Action>>
* Added new <<actionss-hipchat,HipChat Action>>
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like a typo. I think this file may be inert.

The {alert-features} enable you to watch
for changes or anomalies in your data and perform the necessary actions in
TIP: {kib} Alerting provides a set of built-in actions and alerts
that are integrated with the APM, Metrics, Security, and Uptime applications.
Copy link
Contributor

Choose a reason for hiding this comment

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

There will be more apps that integrate with alerting.

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

LGTM

@debadair debadair merged commit ce5a1a9 into elastic:master Dec 8, 2020
debadair added a commit to debadair/elasticsearch that referenced this pull request Dec 8, 2020
…stic#65908)

* [DOCS] Qualified Watcher topics to distinguish from Kib Alerting

* Reverted actions anchor due to client links.

* Updated redirects.

* Fixed links.

* Roll back anchor changes

* Apply suggestions from code review

Co-authored-by: James Rodewig <[email protected]>

* Incorporated review comments.
debadair added a commit to debadair/elasticsearch that referenced this pull request Dec 8, 2020
…stic#65908)

* [DOCS] Qualified Watcher topics to distinguish from Kib Alerting

* Reverted actions anchor due to client links.

* Updated redirects.

* Fixed links.

* Roll back anchor changes

* Apply suggestions from code review

Co-authored-by: James Rodewig <[email protected]>

* Incorporated review comments.
debadair added a commit that referenced this pull request Dec 8, 2020
) (#66064)

* [DOCS] Qualified Watcher topics to distinguish from Kib Alerting

* Reverted actions anchor due to client links.

* Updated redirects.

* Fixed links.

* Roll back anchor changes

* Apply suggestions from code review

Co-authored-by: James Rodewig <[email protected]>

* Incorporated review comments.
debadair added a commit that referenced this pull request Dec 8, 2020
) (#66065)

* [DOCS] Qualified Watcher topics to distinguish from Kib Alerting

* Reverted actions anchor due to client links.

* Updated redirects.

* Fixed links.

* Roll back anchor changes

* Apply suggestions from code review

Co-authored-by: James Rodewig <[email protected]>

* Incorporated review comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Watcher >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.10.0 v7.11.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants