Skip to content

[DOCS] Move snapshot repo types to separate pages#82826

Merged
jrodewig merged 10 commits intoelastic:masterfrom
jrodewig:docs__separate-repo-type-pages
Jan 26, 2022
Merged

[DOCS] Move snapshot repo types to separate pages#82826
jrodewig merged 10 commits intoelastic:masterfrom
jrodewig:docs__separate-repo-type-pages

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Jan 19, 2022

With #81870, the Azure, GCS, and S3 repository types have separate, dedicated pages in the Elasticsearch guide. For consistency, this PR creates separate pages for the shared file system, read-only URL, and source-only repository types.

Related changes:

  • Adds redirects to the plugins docs
  • Fixes a few breaking changes that refer to the Azure, GCS, and S3 repositories as plugins.

Notes for reviewers

Despite the big diffs, I didn't make any substantive changes to the docs. It's mostly copying and pasting the existing docs over to new pages.

The elasticsearch-ci/docs test is also failing due to some broken links in the Kibana UI. This is sort of a chicken-egg situation so we'll likely need to merge without this test passing. I've opened elastic/kibana#123415 to fix the links in Kibana.

Previews

@jrodewig jrodewig added :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes labels Jan 26, 2022
@jrodewig jrodewig marked this pull request as ready for review January 26, 2022 17:02
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed Meta label for distributed team. labels Jan 26, 2022
@elasticmachine
Copy link
Copy Markdown
Collaborator

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

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@jrodewig
Copy link
Copy Markdown
Contributor Author

@elasticmachine run elasticsearch-ci/docs

Copy link
Copy Markdown
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

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

Great changes @jrodewig! I left some non-blocking changes that you can apply if wanted. I realize that section was a copy+paste, but could be a nice improvement.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
@jrodewig
Copy link
Copy Markdown
Contributor Author

Great suggestions @lockewritesdocs. Thanks!

@jrodewig
Copy link
Copy Markdown
Contributor Author

@elasticmachine run elasticsearch-ci/docs skiplinkcheck

@jrodewig
Copy link
Copy Markdown
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@jrodewig jrodewig merged commit cb6265f into elastic:master Jan 26, 2022
@jrodewig jrodewig deleted the docs__separate-repo-type-pages branch January 26, 2022 22:13
jrodewig added a commit to elastic/kibana that referenced this pull request Jan 26, 2022
Updates the Kibana link service for changes related to elastic/elasticsearch#82826.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
@jrodewig
Copy link
Copy Markdown
Contributor Author

💚 All backports created successfully

Status Branch Result
8.0

Questions ?

Please refer to the Backport tool documentation

jrodewig added a commit to elastic/kibana that referenced this pull request Jan 26, 2022
Updates the Kibana link service for changes related to elastic/elasticsearch#82826.

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
(cherry picked from commit f77355b)
jrodewig added a commit that referenced this pull request Jan 26, 2022
With #81870, the Azure, GCS, and S3 repository types have separate, dedicated pages in the Elasticsearch guide. For consistency, this PR creates separate pages for the shared file system, read-only URL, and source-only repository types.

Related changes:

- Adds redirects to the plugins docs
- Fixes a few breaking changes that refer to the Azure, GCS, and S3 repositories as plugins.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
(cherry picked from commit cb6265f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed Meta label for distributed team. Team:Docs Meta label for docs team v8.0.0-rc2 v8.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants