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
Fix some minor typos in the contributing guide and on the runbooks page #3418
Conversation
@@ -1652,7 +1652,7 @@ Ingesters keep, on their persistent disk, the blocks compacted from TSDB head un | |||
|
|||
The blocks retained in the ingesters can be used in case the compactor generates corrupted blocks and the source blocks, shipped from ingesters, have already been hard deleted from the bucket. | |||
|
|||
How to manually blocks from ingesters to the bucket: | |||
How to manually ship blocks from ingesters to the bucket: |
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.
I'm not 100% sure about my use of the word "ship" here - if there's a better verb to use, happy to change it.
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.
I would probably use "upload". In ingester code we dp refer to this upload as "shipping", and it's done by "shipper", but in the documentation I don't think we use that term.
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.
Yes, please change to "upload".
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.
"upload" makes sense to me. I'll also update the line above to use "uploaded" instead of "shipped" to keep things consistent.
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.
lgtm, thank you.
@@ -1652,7 +1652,7 @@ Ingesters keep, on their persistent disk, the blocks compacted from TSDB head un | |||
|
|||
The blocks retained in the ingesters can be used in case the compactor generates corrupted blocks and the source blocks, shipped from ingesters, have already been hard deleted from the bucket. | |||
|
|||
How to manually blocks from ingesters to the bucket: | |||
How to manually ship blocks from ingesters to the bucket: |
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.
I would probably use "upload". In ingester code we dp refer to this upload as "shipping", and it's done by "shipper", but in the documentation I don't think we use that term.
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.
Thank you!
…ngesters to object storage. See #3418 (comment).
…ge (grafana#3418) * Fix minor typos on runbooks page. * Fix capitalisation and other minor typos in contributing guide pages. * Use "upload" rather than "ship" to describe sending blocks from the ingesters to object storage. See grafana#3418 (comment).
What this PR does
I noticed a couple of small typos as I've been reading through the documentation - this PR fixes them.
Which issue(s) this PR fixes or relates to
(none)
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]