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: add ifeval for 7.10 release #1004

Merged
merged 1 commit into from
Nov 3, 2020

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Nov 3, 2020

Summary

This PR fixes a documentation link that will break when 7.10 becomes the current stack version. It conditionally changes the link location of the Logs app docs based on the stack version defined in github.com/elastic/docs (here).

ifeval::["{branch}"=="7.9"]
APM to the {apm-app-ref}/xpack-logs.html[Logs app].
endif::[]
ifeval::["{branch}"!="7.9"]
APM to the {observability-guide}/monitor-logs.html[Logs app].
endif::[]

Admittedly, this isn't pretty, but it's the cleanest way to ensure this link continues to work for users who click it before and after the 7.10 release.

Tested by building locally with :branch: overridden to 7.9, 7.10, and master.

Target

This PR will need to be backported to 1.x.

Related issue

Follow-ups

After the release of 7.10, I will backport a fix that removes the conditional code.

@bmorelli25 bmorelli25 added the docs label Nov 3, 2020
@bmorelli25 bmorelli25 requested review from a team November 3, 2020 21:43
@bmorelli25 bmorelli25 self-assigned this Nov 3, 2020
@apmmachine
Copy link
Contributor

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #1004 opened]

  • Start Time: 2020-11-03T21:43:53.240+0000

  • Duration: 3 min 52 sec

@bmorelli25
Copy link
Member Author

Thanks for the quick review! I'm going to merge this and run a full rebuild on our release PR to make sure everything works correctly before backporting

@bmorelli25 bmorelli25 merged commit bd05868 into elastic:master Nov 3, 2020
@bmorelli25 bmorelli25 deleted the docs-ready-7.10 branch November 3, 2020 22:22
@bmorelli25
Copy link
Member Author

Confirmed that this approach works. Initiating operation backport.

bmorelli25 added a commit to bmorelli25/apm-agent-dotnet that referenced this pull request Nov 4, 2020
@russcam russcam added the v1.7.0 label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants