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 alias guide #73062

Merged
merged 25 commits into from
May 25, 2021
Merged

[DOCS] Add alias guide #73062

merged 25 commits into from
May 25, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented May 13, 2021

Changes:

  • Creates a new Aliases guide to better cover data stream aliases.
  • Migrates several examples from the aliases API docs to the new guide.
  • Updates several API references docs to link to the new guide.

Preview

https://elasticsearch_73062.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/alias.html

@jrodewig jrodewig requested a review from martijnvg May 13, 2021 17:45
@jrodewig jrodewig added :Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes v7.14.0 v8.0.0 labels May 13, 2021
jrodewig added 2 commits May 13, 2021 13:46
Creates a guide for aliases. We can use this guide to house concepts, examples,
and tips for aliases.
@jrodewig jrodewig marked this pull request as ready for review May 13, 2021 18:44
@elasticmachine elasticmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels May 13, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig jrodewig changed the title [DOCS] Create alias guide [DOCS] Add alias guide May 14, 2021
Copy link
Member

@martijnvg martijnvg left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@jrodewig
Copy link
Contributor Author

Thanks @martijnvg!

@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@jrodewig jrodewig merged commit b1ad71b into elastic:master May 25, 2021
@jrodewig jrodewig deleted the docs__add-alias-overview branch May 25, 2021 15:52
jrodewig added a commit that referenced this pull request May 25, 2021
Creates a guide for aliases. We can use this guide to house concepts, examples,
and tips for aliases.
jrodewig added a commit that referenced this pull request Sep 7, 2021
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
jrodewig added a commit that referenced this pull request Sep 7, 2021
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This adds a redirect page for the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.
jrodewig added a commit that referenced this pull request Sep 7, 2021
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This adds a redirect page for the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.
elasticsearchmachine pushed a commit that referenced this pull request Sep 7, 2021
…7357)

* [DOCS] Update anchor and add redirect for aliases (#77349)

PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
# Conflicts:
#	docs/reference/search/multi-search.asciidoc

* [DOCS] Add anchor text to field alias redirect
elasticsearchmachine pushed a commit that referenced this pull request Sep 7, 2021
…7356)

* [DOCS] Update anchor and add redirect for aliases (#77349)

PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
# Conflicts:
#	docs/reference/search/multi-search.asciidoc

* [DOCS] Add anchor text to field alias redirect
elasticsearchmachine pushed a commit that referenced this pull request Sep 7, 2021
)

* [DOCS] Update anchor and add redirect for aliases (#77349)

PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
# Conflicts:
#	docs/reference/search/multi-search.asciidoc

* [DOCS] Add anchor text to field alias redirect
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.14.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants