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: Fix links to APM Server #56537

Merged
merged 1 commit into from
May 11, 2020
Merged

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented May 11, 2020

https://www.elastic.co/guide/en/elasticsearch/reference/7.6/built-in-users.html#add-built-in-user-apm

This PR fixes links in 7.8 that point to the APM Server reference. These links currently point to the 7.0 version of the documentation. This fix should be backported to 7.7 and 7.6.

The root of this problem is that APM Server does not build a 7.x documentation branch. As a workaround, we often tie 7.x links to other versions of the documentation. These links should be updated at a later date, but sometimes they slip through the cracks 🤷.
To fix this in the Kibana reference, we conditionally change links to point to APM Server's master docs when branch == 7.x:

ifeval::[{branch} == 7.x]
:apm-server-ref:       {apm-server-ref-m}
:apm-overview-ref-v:   {apm-overview-ref-m}
endif::[]

Is this a solution you'd be willing to consider in the ES reference? If so, I can open a PR on master.

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. Links go to the right place!

I think implementing attributes similar to the Kibana setup is a great idea. We already have a similar ifeval set up here:

https://github.com/elastic/elasticsearch/blame/master/docs/Versions.asciidoc#L67

Feel free to place the attributes there or in another area of that file.

@jrodewig jrodewig added :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) >docs General docs changes labels May 11, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (:Security/Authentication)

@elasticmachine elasticmachine added the Team:Security Meta label for security team label May 11, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) Team:Docs Meta label for docs team Team:Security Meta label for security team v7.6.0 v7.7.0 v7.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants