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

Add note about collecting from Kubernetes Pods #1972

Merged
merged 2 commits into from
Oct 28, 2024

Conversation

clayton-cornell
Copy link
Contributor

PR Description

In this PR:

  • Minor markdown cleanup
  • Add note about only collecting from Kubernetes Pods, not from Nodes.

Which issue(s) this PR fixes

#431

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell requested a review from a team October 24, 2024 18:31
@clayton-cornell clayton-cornell changed the title Minor syntax and formatting cleanup Add note about collecting from Kubernetes Pods Oct 24, 2024
Copy link
Collaborator

@mattdurham mattdurham left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -163,17 +158,15 @@ Clustering only looks at the following labels for determining the shard key:

## Exported fields

`loki.source.kubernetes` does not export any fields.
`loki.source.kubernetes` doesn't export any fields.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am a bit surprised we prefer contractions!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We generally follow the Google Developer's style guide (with a few modifications as documented in the Writer's Toolkit). Contractions are preferred as outlined here: https://developers.google.com/style/contractions

Quoting the guideline: "In general, we write our documentation in an informal tone, so we recommend using most types of contractions."

@clayton-cornell clayton-cornell merged commit b558c01 into main Oct 28, 2024
24 checks passed
@clayton-cornell clayton-cornell deleted the docs/add-note-loki.source.kubernetes branch October 28, 2024 16:45
Copy link
Contributor

The backport to release/v1.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-1972-to-release/v1.0 origin/release/v1.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b558c01237c16536f46e8cdafdebde9156da158b
# Push it to GitHub
git push --set-upstream origin backport-1972-to-release/v1.0
git switch main
# Remove the local backport branch
git branch -D backport-1972-to-release/v1.0

Then, create a pull request where the base branch is release/v1.0 and the compare/head branch is backport-1972-to-release/v1.0.

Copy link
Contributor

The backport to release/v1.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-1972-to-release/v1.1 origin/release/v1.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b558c01237c16536f46e8cdafdebde9156da158b
# Push it to GitHub
git push --set-upstream origin backport-1972-to-release/v1.1
git switch main
# Remove the local backport branch
git branch -D backport-1972-to-release/v1.1

Then, create a pull request where the base branch is release/v1.1 and the compare/head branch is backport-1972-to-release/v1.1.

Copy link
Contributor

The backport to release/v1.2 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-1972-to-release/v1.2 origin/release/v1.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b558c01237c16536f46e8cdafdebde9156da158b
# Push it to GitHub
git push --set-upstream origin backport-1972-to-release/v1.2
git switch main
# Remove the local backport branch
git branch -D backport-1972-to-release/v1.2

Then, create a pull request where the base branch is release/v1.2 and the compare/head branch is backport-1972-to-release/v1.2.

Copy link
Contributor

The backport to release/v1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-1972-to-release/v1.3 origin/release/v1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b558c01237c16536f46e8cdafdebde9156da158b
# Push it to GitHub
git push --set-upstream origin backport-1972-to-release/v1.3
git switch main
# Remove the local backport branch
git branch -D backport-1972-to-release/v1.3

Then, create a pull request where the base branch is release/v1.3 and the compare/head branch is backport-1972-to-release/v1.3.

github-actions bot pushed a commit that referenced this pull request Oct 28, 2024
clayton-cornell added a commit that referenced this pull request Oct 28, 2024
clayton-cornell added a commit that referenced this pull request Oct 28, 2024
clayton-cornell added a commit that referenced this pull request Oct 28, 2024
clayton-cornell added a commit that referenced this pull request Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants