Skip to content

[DOCS] Align with ILM changes.#55953

Merged
debadair merged 10 commits intoelastic:masterfrom
debadair:slm-update
May 8, 2020
Merged

[DOCS] Align with ILM changes.#55953
debadair merged 10 commits intoelastic:masterfrom
debadair:slm-update

Conversation

@debadair
Copy link
Copy Markdown
Contributor

No description provided.

@debadair debadair added >docs General docs changes WIP :Data Management/ILM+SLM DO NOT USE. Use ":StorageEngine/ILM" or ":Distributed Coordination/SLM" instead. labels Apr 29, 2020
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-core-features (:Core/Features/ILM+SLM)

@elasticmachine elasticmachine added the Team:Data Management (obsolete) DO NOT USE. This team no longer exists. label Apr 29, 2020
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Apr 29, 2020
Copy link
Copy Markdown
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up @debadair, I left a few comments!

Comment on lines -58 to -60
| `expire_after` | A timevalue for how old a snapshot must be in order to be eligible for deletion.
| `min_count` | A minimum number of snapshots to keep, regardless of age.
| `max_count` | The maximum number of snapshots to keep, regardless of age.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We're removing the description of these options, but I don't see them documented anywhere else now other than once in the example API request. I think we still need to document these configuration options somewhere

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.

Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
indices using the <<snapshot-restore,snapshots>> every day at a particular
time. Once these snapshots have been created, they are kept for a configured
amount of time and then deleted per a configured retention policy.
This tutorial demonstrates how to automate daily back ups of {es} indices using an {slm-init} policy.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This tutorial demonstrates how to

I thought we typically strayed away form this type of meta language. We could probably rephrase to something like You can use an {slim-init} policy 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.

Tutorials are the one place the meta-info doesn't really bother me. I'm going to leave it for now & look at the language we use in other places. I'll open another PR to be consistent, one way or another. (With tutorial in the titles, it's not really necessary to repeat "tutorial" in the text for SEO purposes.)

Copy link
Copy Markdown
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.

+1 to @dakrone's feedback. I also left some suggestions needed formatting changes.
It may be a good idea to check out the preview of this one before publishing.

Most of the other comments are nits or things I wondered about. Those
aren't blocking and you can ignore if wanted.

debadair and others added 3 commits May 7, 2020 13:43
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
@debadair
Copy link
Copy Markdown
Contributor Author

debadair commented May 7, 2020

@elasticmachine test this please

@debadair debadair merged commit f7cd772 into elastic:master May 8, 2020
debadair added a commit to debadair/elasticsearch that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit to debadair/elasticsearch that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit to debadair/elasticsearch that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit to debadair/elasticsearch that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
debadair added a commit that referenced this pull request May 8, 2020
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Data Management/ILM+SLM DO NOT USE. Use ":StorageEngine/ILM" or ":Distributed Coordination/SLM" instead. >docs General docs changes Team:Data Management (obsolete) DO NOT USE. This team no longer exists. Team:Docs Meta label for docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants