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] Work around for titleabbrev errors #34201

Merged
merged 1 commit into from
Apr 1, 2019

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 29, 2019

Summary

Related to elastic/docs#756

This PR works around elastic/docs#760 by adding a substitutions attribute for abbreviated titles that contain attributes. Otherwise, they are not resolved by Asciidoctor builds. For example:

image

[skip ci]

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

- [ ] This was checked for cross-browser compatibility, including a check against IE11
- [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support

For maintainers

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@schersh schersh self-requested a review April 1, 2019 19:29
Copy link
Contributor

@schersh schersh left a comment

Choose a reason for hiding this comment

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

LGTM. To confirm, any page that uses an attribute in the title will need to add [subs="attributes"] under the header? @gchaps and I should keep an eye out for these, I think there are more out there. Do you run into any issues backporting this far?

@lcawl
Copy link
Contributor Author

lcawl commented Apr 1, 2019

To confirm, any page that uses an attribute in the title will need to add [subs="attributes"] under the header?

Only pages that use attributes within <titleabbrev>. I'm cleaning up all occurrences I've found, but yes, it's something to keep an eye out for.

@lcawl lcawl merged commit 7198a1f into elastic:master Apr 1, 2019
@lcawl lcawl deleted the abbrevtitle-fix branch April 1, 2019 20:24
lcawl added a commit that referenced this pull request Apr 1, 2019
lcawl added a commit that referenced this pull request Apr 1, 2019
@lcawl lcawl removed the v7.0.1 label Apr 1, 2019
@lcawl
Copy link
Contributor Author

lcawl commented Apr 1, 2019

Backported to 6.7 and earlier via d985a0a

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.

3 participants