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

Update paths, references to River, and config/binary paths and names #84

Merged
merged 7 commits into from
Mar 26, 2024

Conversation

clayton-cornell
Copy link
Contributor

PR Description

Update paths, references to River, and config/binary paths and names

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 added the type/docs Docs Squad label across all Grafana Labs repos label Mar 26, 2024
@clayton-cornell clayton-cornell merged commit 68d3c26 into main Mar 26, 2024
9 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-paths-names branch March 26, 2024 23:48
Copy link
Member

Choose a reason for hiding this comment

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

This file isn't templated/rendered to the docs site so {{< param "PRODUCT_NAME" >}} should be replaced with literal "Alloy" instances here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in a new PR

@@ -7,7 +7,7 @@ weight: 300

# Collect OpenTelemetry data

{{< param "PRODUCT_NAME" >}} can be configured to collect [OpenTelemetry][]-compatible data and forward it to any OpenTelemetry-compatible endpoint.
Youc an configure {{< param "PRODUCT_NAME" >}} to collect [OpenTelemetry][]-compatible data and forward it to any OpenTelemetry-compatible endpoint.
Copy link
Member

Choose a reason for hiding this comment

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

Youc an :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in a new PR

@@ -56,7 +55,7 @@ binary, perform the following steps:

1. Type `services.msc` and click **OK**.

1. Right click on the service called **{{< param "PRODUCT_NAME" >}}**.
1. Right click on the service called **{{< param "FULL_PRODUCT_NAME" >}}**.
Copy link
Member

Choose a reason for hiding this comment

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

Based on the current spreadsheet, this might not be correct anymore (Alloy, not Grafana Alloy). Maybe in this particular case we should spell it out explicitly rather than using the param so it's easier to review when looking at the raw markdown?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I missed that one in this edit. Fixed in a new PR

@@ -31,7 +31,7 @@ If you are running a custom installation of {{< param "PRODUCT_NAME" >}}, refer

### Home page

![](../../assets/ui_home_page.png)
![](/media/docs/agent/ui_home_page.png)
Copy link
Member

Choose a reason for hiding this comment

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

will these URLs be changed to Alloy later?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All images will need to be updated for Alloy - most are Agent-specific screencaps.

@@ -5,7 +5,7 @@ title: Monitor controller
weight: 100
---

# How to monitor controller
# Monitor controller
Copy link
Member

Choose a reason for hiding this comment

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

Feels weird for an article to be missing here. "Monitor the controller?" (or "Monitor the component controller?")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I had that one flagged to come back to in a content tidy. Fixed the H1 level in a new PR. Now it reads Monitor the Grafana Agent component controller (H1 should spell out the full product name, Grafana Alloy)

@rfratto rfratto added the backport-to-agent:no PR should NOT be backported to the agent repo. label Apr 23, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport-to-agent:no PR should NOT be backported to the agent repo. frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants