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

Remove sudo command from RHEL Fedora install instructions #5189

Merged
merged 1 commit into from
Sep 13, 2023

Conversation

clayton-cornell
Copy link
Contributor

PR Description

This PR removes a sudo command that slipped into the Linux install instructions for RHEL/Fedora

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

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

@clayton-cornell clayton-cornell merged commit 646630c into main Sep 13, 2023
10 checks passed
@clayton-cornell clayton-cornell deleted the docs/fix-typo-linux-install branch September 13, 2023 22:28
grafanabot pushed a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)
grafanabot pushed a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)
grafanabot pushed a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)
@@ -72,7 +72,6 @@ To install Grafana Agent in static mode on RHEL or Fedora, run the following com
1. Create `/etc/yum.repos.d/grafana.repo` with the following content:

```shell
Copy link

Choose a reason for hiding this comment

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

Suggested change
```shell
```ini

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@aam1r I merged before I saw your comment. Help me understand the reasoning for using ini vs shell (or bash) for the codeblock language here

Copy link

Choose a reason for hiding this comment

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

My apologies for the lack of explanation.

.repo files use a similar syntax as INI files (see https://en.wikipedia.org/wiki/INI_file). shell is more appropriate for shell commands such as the ones below, whereas ini is more appropriate for this particular configuration change.

Before (shell):

[grafana]
name=grafana
baseurl=https://rpm.grafana.com
repo_gpgcheck=1
enabled=1
gpgcheck=1
gpgkey=https://rpm.grafana.com/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt

After (ini):

[grafana]
name=grafana
baseurl=https://rpm.grafana.com
repo_gpgcheck=1
enabled=1
gpgcheck=1
gpgkey=https://rpm.grafana.com/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt

Notice the better color formatting when using ini 🙂 FYI, this is just a cosmetic change with no impact on the overall instructions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah cool. For consistency, if I change it here, I'd want to dig through the other places it could also be used. I've got some changes pending/planned for the install docs. I'll give it a try and see how it fits into the existing docs.

clayton-cornell added a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)

Co-authored-by: Clayton Cornell <[email protected]>
clayton-cornell added a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)

Co-authored-by: Clayton Cornell <[email protected]>
clayton-cornell added a commit that referenced this pull request Sep 13, 2023
(cherry picked from commit 646630c)

Co-authored-by: Clayton Cornell <[email protected]>
@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 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.34 backport release-v0.35 backport release-v0.36 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.

3 participants