-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Retention doc #3775
Retention doc #3775
Conversation
Signed-off-by: Cyril Tovena <[email protected]>
Signed-off-by: Cyril Tovena <[email protected]>
As a more general question, if this new documentation describes an experimental feature, should there be prose that explicitly states which parts are experimental? |
Totally agree, this is stated line 12. Do you think it should be more explicit than that ?
|
Signed-off-by: Cyril Tovena <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few last corrections I would like you to consider. I believe the prose is good once these changes are made.
@@ -5,33 +5,31 @@ title: Retention | |||
|
|||
Retention in Loki is achieved either through the [Table Manager](#table-manager) or the [Compactor](#Compactor). | |||
|
|||
## Which one should you use ? | |||
Which one should you use ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this line completely. We don't need the question, since the sentence above it implies that we'll be describing both.
|
||
2. It gives you a short period to cancel chunks deletion in case of mistakes. | ||
|
||
Marker files (containing chunks to deletes), should be store on a persistent disk, since this is the sole reference to them anymore. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now, let's fix some grammar, and consider in the future how to make this better. In the future, we should either explain how to cancel the deletion or provide a link within the docs to the place where it is explained.
Co-authored-by: Karen Miller <[email protected]>
Co-authored-by: Karen Miller <[email protected]>
Co-authored-by: Karen Miller <[email protected]>
Co-authored-by: Karen Miller <[email protected]>
This adds documentation for the experimental custom retention feature through the compactor.
/cc @sandeepsukhani see how you can hook up your deletion documentation into it.