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

Clean up and correct Grafana Agent Static install on Linux #3931

Merged
merged 7 commits into from
May 24, 2023

Conversation

clayton-cornell
Copy link
Contributor

PR Description

The existing Grafana Agent Static install docs for Linux are not formatted correctly (markdown errors) and are not correct for openSUSE.

Issue: #3903

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG updated
  • Documentation added
  • Tests updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label May 18, 2023
@clayton-cornell clayton-cornell self-assigned this May 18, 2023
@clayton-cornell
Copy link
Contributor Author

Changes to the topic:

  • Fixed markdown indenting for code blocks
  • Fixed step numbering
  • Removed reference to deprecated Linux command in Debian/Ubuntu section
  • Added openSUSE/SUSE section
  • Changed systemd restart to reload
  • General alignment to Grafana Agent Flow wording/style

@clayton-cornell
Copy link
Contributor Author

@marctc @zeitlinger Can one of you take a look over the changes I'm suggesting here. The main updates are around the new openSUSE. The other changes are generally markdown cleanup. I've tested the openSUSE section and it all seems to work correctly.

@zeitlinger
Copy link
Member

I'm not an expert on the agent - what should I look at in particular?

@clayton-cornell
Copy link
Contributor Author

clayton-cornell commented May 24, 2023

In particular, I'd like some developer eyes on:

  1. The openSUSE steps
  2. The change from systemd restart to systemd reload
  3. Removing the deprecated apt-key section

(everything else that was changed is cosmetic)

@zeitlinger
Copy link
Member

In particular, I'd like some developer eyes on:

  1. The openSUSE steps
  2. The change from systemd restart to systemd reload`
  3. Removing the deprecated apt-key section

(everything else that was changed is cosmetic)

I'm also not familiar with that - please reach out to the #agent team

@clayton-cornell clayton-cornell requested review from rfratto and removed request for zeitlinger May 24, 2023 15:14
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@clayton-cornell clayton-cornell removed the request for review from marctc May 24, 2023 16:30
Copy link

@Eve832 Eve832 left a comment

Choose a reason for hiding this comment

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

lgtm!

@clayton-cornell
Copy link
Contributor Author

Reviewed and ready to merge

@clayton-cornell clayton-cornell enabled auto-merge (squash) May 24, 2023 16:50
@clayton-cornell clayton-cornell merged commit 4b8807a into main May 24, 2023
@clayton-cornell clayton-cornell deleted the doc/fix_markdown_install_agent_linux branch May 24, 2023 16:58
@grafanabot
Copy link
Contributor

The backport to release-v0.32 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-3931-to-release-v0.32 origin/release-v0.32
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4b8807a517071556c7fd520d7ddd792fbcd311f7
# Push it to GitHub
git push --set-upstream origin backport-3931-to-release-v0.32
git switch main
# Remove the local backport branch
git branch -D backport-3931-to-release-v0.32

Then, create a pull request where the base branch is release-v0.32 and the compare/head branch is backport-3931-to-release-v0.32.

@grafanabot
Copy link
Contributor

The backport to release-v0.33 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-3931-to-release-v0.33 origin/release-v0.33
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4b8807a517071556c7fd520d7ddd792fbcd311f7
# Push it to GitHub
git push --set-upstream origin backport-3931-to-release-v0.33
git switch main
# Remove the local backport branch
git branch -D backport-3931-to-release-v0.33

Then, create a pull request where the base branch is release-v0.33 and the compare/head branch is backport-3931-to-release-v0.33.

clayton-cornell added a commit that referenced this pull request May 24, 2023
* First pass correcting Static install Linux

* Correct some details for openSUSE

* Simplify openSUSE step

* Update heading levels

(cherry picked from commit 4b8807a)
@clayton-cornell
Copy link
Contributor Author

Backported to v0.33. Removed backport to v0.32.

clayton-cornell added a commit that referenced this pull request May 24, 2023
…3969)

* First pass correcting Static install Linux

* Correct some details for openSUSE

* Simplify openSUSE step

* Update heading levels

(cherry picked from commit 4b8807a)
clayton-cornell added a commit that referenced this pull request Aug 14, 2023
* First pass correcting Static install Linux

* Correct some details for openSUSE

* Simplify openSUSE step

* Update heading levels
clayton-cornell added a commit that referenced this pull request Aug 14, 2023
* First pass correcting Static install Linux

* Correct some details for openSUSE

* Simplify openSUSE step

* Update heading levels
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 24, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.33 frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants