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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add canonical URL to glossary page #83752

Closed
wants to merge 2 commits into from
Closed

[DOCS] Add canonical URL to glossary page #83752

wants to merge 2 commits into from

Conversation

gtback
Copy link
Member

@gtback gtback commented Feb 9, 2022 •
edited by jrodewig
Loading

This commit demonstrates how to
add a canonical URL, which will be included in the HTML metadata
on output.

Depends on elastic/docs#2373

@gtback
Add canonical URL to Frozen Indices page
575fca7 
This functionality has been deprecated. This commit demonstrates how to
add a canonical URL, which will be included in the HTML <head> metadata
on output.

Depends on elastic/docs#2373
@gtback gtback added >docs General docs changes Team:Docs Meta label for docs team labels Feb 9, 2022
@gtback gtback requested a review from jrodewig February 9, 2022 19:17
@elasticsearchmachine elasticsearchmachine added v8.2.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Feb 9, 2022
@gtback
Copy link
Member Author

gtback commented Feb 9, 2022

Once the Docs PR is merged, I'll rerun the doc build job and examine the HTML diff, which should show the changes in this PR.

@gtback
Copy link
Member Author

gtback commented Feb 9, 2022

cc: @Dinomoe @AnneB-SEO

@jrodewig
Copy link
Contributor

jrodewig commented Feb 9, 2022

@gtback @AnneB-SEO Can we pick another example for this?

As pointed out in #70192 (comment), frozen indices aren't related to the frozen tier. The two features don't necessarily serve the same use cases.

@jrodewig jrodewig changed the title Add canonical URL to Frozen Indices page [DOCS] Add canonical URL to Frozen Indices page Feb 9, 2022
@gtback
Copy link
Member Author

gtback commented Feb 9, 2022

Thanks, @jrodewig , I'm happy to use a different example. Do you have any suggestions?

@jrodewig jrodewig changed the title [DOCS] Add canonical URL to Frozen Indices page [DOCS] Add canonical URL to Glossary page Feb 10, 2022
@jrodewig
Copy link
Contributor

Thanks, @jrodewig , I'm happy to use a different example. Do you have any suggestions?

I pushed 3a04c01 to use the ES glossary instead. Feel free to revert if that doesn't match the criteria you had in mind. Thanks!

@jrodewig jrodewig changed the title [DOCS] Add canonical URL to Glossary page [DOCS] Add canonical URL to glossary page Feb 10, 2022
@gtback
Copy link
Member Author

gtback commented Feb 10, 2022

@elasticmachine run elasticsearch-ci/docs

@gtback
Copy link
Member Author

gtback commented Feb 10, 2022

I'm running tests again since merging the elastic/docs PR, to confirm in the diff that the link shows up in the <head> element correctly.

I don't have a strong stake in where the link goes; I'll leave that up to you 😁

jrodewig
jrodewig approved these changes Feb 10, 2022
View reviewed changes
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, but @AnneB-SEO will probably want to make sure this is a good example.

Thanks!

@gtback
Copy link
Member Author

gtback commented Feb 10, 2022

https://elasticsearch_83752.docs-preview.app.elstc.co/diff has the diff, showing a single line added to https://elasticsearch_83752.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/glossary.html

<link rel="canonical" href="https://www.elastic.co/guide/en/elastic-stack-glossary/current/terms.html"/>

@gtback gtback closed this Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrodewig jrodewig jrodewig approved these changes

Assignees
No one assigned
Labels
>docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.4.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gtback @jrodewig @craigtaverner @elasticsearchmachine @salvatore-campagna