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

Use documentation link service for Watcher #93339

Merged
merged 6 commits into from
Mar 16, 2021
Merged

Use documentation link service for Watcher #93339

merged 6 commits into from
Mar 16, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 2, 2021

Summary

Relates to #88107

This PR replaces hard-coded links with keywords from the documentation link service.

CC @lcawl

Screenshot

The links are used in the Watcher UI in places like this:

Screen Shot 2021-03-02 at 5 47 11 PM

@jrodewig jrodewig added Feature:Watcher v8.0.0 release_note:skip Skip the PR/issue when compiling release notes docs v7.13.0 labels Mar 2, 2021
@jrodewig jrodewig marked this pull request as ready for review March 3, 2021 01:01
@jrodewig jrodewig requested a review from a team as a code owner March 3, 2021 01:01
@mshustov mshustov removed their request for review March 3, 2021 08:35
@jrodewig
Copy link
Contributor Author

jrodewig commented Mar 5, 2021

@elasticmachine merge upstream

@jrodewig
Copy link
Contributor Author

jrodewig commented Mar 8, 2021

@elasticmachine merge upstream

@jrodewig
Copy link
Contributor Author

@elasticmachine merge upstream

@jrodewig
Copy link
Contributor Author

@elasticmachine merge upstream

@jloleysens
Copy link
Contributor

@elasticmachine merge upstream

Comment on lines +24 to +26
[ACTION_TYPES.SLACK]: `${links.watcher.slackAction}`,
[ACTION_TYPES.PAGERDUTY]: `${links.watcher.pagerDutyAction}`,
[ACTION_TYPES.JIRA]: `${links.watcher.jiraAction}`,
Copy link
Contributor

Choose a reason for hiding this comment

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

i noticed when testing this that the #configuring-x hash was removed from the end of the URL after these changes were applied. Do you think we should re-add them @jrodewig ?

Copy link
Contributor Author

@jrodewig jrodewig Mar 15, 2021

Choose a reason for hiding this comment

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

Thanks @jloleysens. This is intentional. I think the links are better without the anchor. The intro of each action page contains requirements that apply to both UI and API users. For example, in the Slack action docs:

Screen Shot 2021-03-15 at 11 14 08 AM

Linking to the #configuring-x "skips" this intro. The #configuring-x sections just provide an API equivalent of the UI configuration. I don't think it'll be helpful to UI users in most cases.

Screen Shot 2021-03-15 at 11 13 59 AM

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
watcher 887.2KB 886.9KB -390.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Thanks for explaining the decision to remove the hash in the URLs @jrodewig . Happy for these changes to be merged.

@jrodewig
Copy link
Contributor Author

Thanks @jloleysens!

@jrodewig jrodewig merged commit 6c9cfd4 into elastic:master Mar 16, 2021
@jrodewig jrodewig deleted the watcher-doc-links branch March 16, 2021 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Watcher release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants