Skip to content
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

Merged
merged 3 commits into from Nov 10, 2022

Conversation

charleskorn
Copy link
Contributor

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

  • [n/a] Tests updated
  • [n/a] Documentation added
  • [n/a] CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@charleskorn charleskorn requested review from osg-grafana and a team as code owners November 9, 2022 03:14
@@ -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:
Copy link
Contributor Author

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.

Copy link
Member

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.

Copy link
Contributor

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".

Copy link
Contributor Author

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.

Copy link
Member

@pstibrany pstibrany left a 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:
Copy link
Member

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.

Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

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

Thank you!

@osg-grafana osg-grafana added the type/docs Improvements or additions to documentation label Nov 9, 2022
@charleskorn charleskorn requested a review from a team as a code owner November 9, 2022 23:05
@pracucci pracucci merged commit fa8f4b7 into main Nov 10, 2022
@pracucci pracucci deleted the docs-typos branch November 10, 2022 05:14
masonmei pushed a commit to udmire/mimir that referenced this pull request Dec 16, 2022
…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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants