Skip to content

fix(docs): Update configuration.md - #17269

Merged
JStickler merged 1 commit into
grafana:mainfrom
mitchnemirov:patch-1
Apr 17, 2025
Merged

fix(docs): Update configuration.md#17269
JStickler merged 1 commit into
grafana:mainfrom
mitchnemirov:patch-1

Conversation

@mitchnemirov

@mitchnemirov mitchnemirov commented Apr 16, 2025

Copy link
Copy Markdown
Contributor

Corrected keep-file description true and false notes.

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR
Corrected keep-file description true and false notes.

Signed-off-by: Mitch Nemirovsky <7938872+mitchnemirov@users.noreply.github.com>
@mitchnemirov
mitchnemirov requested a review from a team as a code owner April 16, 2025 22:09
@CLAassistant

CLAassistant commented Apr 16, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Apr 16, 2025
@paul1r paul1r changed the title Update configuration.md Apr 17, 2025
@paul1r

paul1r commented Apr 17, 2025

Copy link
Copy Markdown
Collaborator

Doc change appears to be correct, the default is false:
https://github.com/grafana/loki/blob/main/clients/cmd/docker-driver/driver.go#L84

Thank you for the submission!

@loki-gh-app

loki-gh-app Bot commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

The backport to release-3.1.x 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-17269-to-release-3.1.x origin/release-3.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 70de5235b7c0e5a549f4bbc7cd127956d595badb

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-17269-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 17269 --json body --template 'Backport 70de5235b7c0e5a549f4bbc7cd127956d595badb from #17269{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'fix(docs): Update configuration.md (backport release-3.1.x)' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-3.1.x --milestone release-3.1.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-17269-to-release-3.1.x

# Create a pull request where the `base` branch is `release-3.1.x` and the `compare`/`head` branch is `backport-17269-to-release-3.1.x`.

# Remove the local backport branch
git switch main
git branch -D backport-17269-to-release-3.1.x
loki-gh-app Bot pushed a commit that referenced this pull request Apr 17, 2025
Signed-off-by: Mitch Nemirovsky <7938872+mitchnemirov@users.noreply.github.com>
(cherry picked from commit 70de523)
@loki-gh-app

loki-gh-app Bot commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

The backport to release-3.0.x 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-17269-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 70de5235b7c0e5a549f4bbc7cd127956d595badb

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-17269-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 17269 --json body --template 'Backport 70de5235b7c0e5a549f4bbc7cd127956d595badb from #17269{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'fix(docs): Update configuration.md (backport release-3.0.x)' --body-file - --label 'size/XS' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-17269-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-17269-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-17269-to-release-3.0.x
loki-gh-app Bot pushed a commit that referenced this pull request Apr 17, 2025
Signed-off-by: Mitch Nemirovsky <7938872+mitchnemirov@users.noreply.github.com>
(cherry picked from commit 70de523)
loki-gh-app Bot pushed a commit that referenced this pull request Apr 17, 2025
Signed-off-by: Mitch Nemirovsky <7938872+mitchnemirov@users.noreply.github.com>
(cherry picked from commit 70de523)
felix0102 pushed a commit to felix0102/loki that referenced this pull request Aug 2, 2026
Signed-off-by: Mitch Nemirovsky <7938872+mitchnemirov@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

4 participants