Skip to content

[DOCS] Update migration APIs docs#83901

Merged
jrodewig merged 2 commits intoelastic:masterfrom
jrodewig:docs__update-migration-api-docs
Feb 15, 2022
Merged

[DOCS] Update migration APIs docs#83901
jrodewig merged 2 commits intoelastic:masterfrom
jrodewig:docs__update-migration-api-docs

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Feb 14, 2022

  • Adds a shared note that the migration APIs are mainly intended for internal use by Kibana's Upgrade Assistant.
  • Updates the feature migration API docs to use updated "migration" terminology.
  • Removes some references to major versions from the deprecation API docs.

Relates to #78802.

Preview

https://elasticsearch_83901.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/migration-api.html

@jrodewig jrodewig added v7.16.4 v7.17.1 v8.0.1 v8.1.0 :Core/Infra/Core Core issues without another label >docs General docs changes labels Feb 14, 2022
@jrodewig jrodewig marked this pull request as ready for review February 14, 2022 18:55
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Core/Infra Meta label for core/infra team labels Feb 14, 2022
@elasticmachine
Copy link
Copy Markdown
Collaborator

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

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@@ -0,0 +1,4 @@
TIP: These APIs are designed for indirect use by {kib}'s **Upgrade Assistant**.
We strongly recommend you use the **Upgrade Assistant** to upgrade from
{prev-major-last} to {version}. For upgrade instructions, refer to
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

from {prev-major-last} to {version}

In the 7.17 backport, I'll update this to "from 7.17 to 8.0 and later versions."

Copy link
Copy Markdown
Contributor

@AthenaEryma AthenaEryma left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jrodewig
Copy link
Copy Markdown
Contributor Author

💚 All backports created successfully

Status Branch Result
8.1
8.0
7.17

Questions ?

Please refer to the Backport tool documentation

elasticsearchmachine pushed a commit that referenced this pull request Feb 15, 2022
* Adds a shared note that the migration APIs are mainly intended for internal use by Kibana's Upgrade Assistant.
* Updates the feature migration API docs to use updated "migration" terminology.
* Removes some references to major versions from the deprecation API docs.

(cherry picked from commit e117812)
elasticsearchmachine pushed a commit that referenced this pull request Feb 15, 2022
* Adds a shared note that the migration APIs are mainly intended for internal use by Kibana's Upgrade Assistant.
* Updates the feature migration API docs to use updated "migration" terminology.
* Removes some references to major versions from the deprecation API docs.

(cherry picked from commit e117812)

# Conflicts:
#	docs/reference/redirects.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Feb 15, 2022
* Adds a shared note that the migration APIs are mainly intended for internal use by Kibana's Upgrade Assistant.
* Updates the feature migration API docs to use updated "migration" terminology.
* Removes some references to major versions from the deprecation API docs.

(cherry picked from commit e117812)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Core/Infra/Core Core issues without another label >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v7.17.1 v8.0.1 v8.1.0 v8.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants