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

Adjusted alias doc for clarity #120437

Merged
merged 6 commits into from
Jan 28, 2025
Merged

Adjusted alias doc for clarity #120437

merged 6 commits into from
Jan 28, 2025

Conversation

thekofimensah
Copy link
Contributor

Added emphasis for the no downtime point as well as changed the wording for clarity

Added emphasis for the no downtime point as well as changed the wording for clarity
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.17.2 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 18, 2025
@AI-IshanBhatt AI-IshanBhatt removed the external-contributor Pull request authored by a developer outside the Elasticsearch team label Jan 20, 2025
@georgewallace georgewallace self-assigned this Jan 21, 2025
@georgewallace georgewallace added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v8.16.0 v0.90.0 v8.18.0 v9.0.0 and removed v0.90.0 labels Jan 21, 2025
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jan 21, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@georgewallace
Copy link
Contributor

@leemthompo I don't know much about Alias'. Mind to review this for accuracy for me?

@leemthompo
Copy link
Contributor

leemthompo commented Jan 22, 2025

I think the original is terse, but I think this change only introduces two minor statements:

  • Changes to aliases are instantaneous
  • This is advantageous in production (implicit in original)

Otherwise, this is a more verbose repackaging of the original information. I'd try to introduce those facts while maintaining concision.

Copy link
Contributor

@georgewallace georgewallace left a comment

Choose a reason for hiding this comment

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

@leemthompo how about this? Hopefully not too verbose

docs/reference/alias.asciidoc Outdated Show resolved Hide resolved
docs/reference/alias.asciidoc Outdated Show resolved Hide resolved
@leemthompo
Copy link
Contributor

run docs-build

@leemthompo
Copy link
Contributor

@elasticmachine test this

@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.16
main
8.x

georgewallace added a commit to georgewallace/elasticsearch that referenced this pull request Jan 28, 2025
Co-authored-by: George Wallace <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
georgewallace added a commit to georgewallace/elasticsearch that referenced this pull request Jan 28, 2025
Co-authored-by: George Wallace <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
georgewallace added a commit to georgewallace/elasticsearch that referenced this pull request Jan 28, 2025
Co-authored-by: George Wallace <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 28, 2025
elasticsearchmachine pushed a commit that referenced this pull request Jan 28, 2025
elasticsearchmachine pushed a commit that referenced this pull request Jan 28, 2025
@thekofimensah thekofimensah deleted the patch-7 branch January 28, 2025 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v8.16.0 v8.17.2 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants