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

Adds alphabetical links to Glossary #1214

Merged
merged 6 commits into from
Jun 25, 2020
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 24, 2020

Depends on elastic/kibana#69721 and elastic/docs#1875

This PR adds alphabetical sections and links to the Glossary (https://www.elastic.co/guide/en/elastic-stack-glossary/current/index.html). It also moves the "Introduction" page into the "Terminology" page, so that there's only one page in this book.

Preview

https://stack-docs_1214.docs-preview.app.elstc.co/guide/en/elastic-stack-glossary/master/terms.html

@lcawl lcawl added the v8.0.0 label Jun 24, 2020
@lcawl lcawl requested a review from gchaps June 24, 2020 21:19
@lcawl lcawl marked this pull request as ready for review June 24, 2020 21:19
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.

The A, B, C headings are showing up in the right side bar.

Also, how about removing the heading "Introduction"? I'm not sure it's needed.

@lcawl
Copy link
Contributor Author

lcawl commented Jun 24, 2020

The A, B, C headings are showing up in the right side bar.

Yes, unfortunately discrete attributes don't seem to affect H3 titles in that "On this page" section after all.

Also, how about removing the heading "Introduction"? I'm not sure it's needed.

I kept it in case there were links to that existing page. I can try removing it and see if anything breaks, however.

@lcawl
Copy link
Contributor Author

lcawl commented Jun 25, 2020

I will revert to sections instead of description lists since I don't like the indentation issues we're hitting per elastic/docs#1876

@gtback
Copy link
Member

gtback commented Jun 25, 2020

I will revert to sections instead of description lists

I feel like using section headers for each letter would be more semantically correct than description links anyway. 👍

I imagine there's a bug in how Asciidoctor tries to infer the list hierarchy, because it seems like it would be pretty complex.

@lcawl lcawl merged commit a19aa6d into elastic:master Jun 25, 2020
@lcawl lcawl deleted the sort-glossary branch June 25, 2020 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants