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

docs: Update Grafana Agent to Grafana Alloy #12602

Merged
merged 2 commits into from
May 28, 2024
Merged

docs: Update Grafana Agent to Grafana Alloy #12602

merged 2 commits into from
May 28, 2024

Conversation

JStickler
Copy link
Contributor

@JStickler JStickler commented Apr 12, 2024

What this PR does / why we need it:
This PR updates the documentation to note that Grafana Agent has been deprecated in favor of Grafana Alloy.
Adds note that Promtail is feature complete.
Also fixes a few typos and updates a few cross-references to use full URLs.

Special notes for your reviewer:
I left the references to Grafana Agent in the following places:

  • Helm charts documentation, because I don't think we've updated the charts to use Alloy yet.
  • Migration documentation, as it is likely that users who are migrating would still be using the Grafana Agent.

{{< docs/shared source="alloy" lookup="agent-deprecation.md" version="next" >}} Will pull in a shared file from the Alloy docs that inserts the following Caution. (Screen shot from Tempo docs, only the Caution will be imported)

AlloyCaution

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Apr 12, 2024
@JStickler JStickler requested a review from a team as a code owner April 12, 2024 20:15
Copy link
Contributor

@MichelHollands MichelHollands left a comment

Choose a reason for hiding this comment

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

LGTM

@JStickler JStickler changed the title docs: Update Grafana Agent to Grafana Alloy (WIP) docs: Update Grafana Agent to Grafana Alloy Apr 23, 2024
@JStickler JStickler changed the title (WIP) docs: Update Grafana Agent to Grafana Alloy docs: Update Grafana Agent to Grafana Alloy May 24, 2024
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit 74a5bbc into main May 28, 2024
61 checks passed
@JStickler JStickler deleted the AlloyUpdats branch May 28, 2024 19:54
@grafanabot
Copy link
Collaborator

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-12602-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 74a5bbc5caa3cea306aa7047b73fb81738d80872

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-12602-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 12602 --json body --template 'Backport 74a5bbc5caa3cea306aa7047b73fb81738d80872 from #12602{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-3.0.x] docs: Update Grafana Agent to Grafana Alloy' --body-file - --label 'size/M' --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-12602-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-12602-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-12602-to-release-3.0.x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport-failed size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants