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.

Sign up for GitHub

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

Jump to bottom

Docs/Adds Alloy configs #8489

Merged
merged 37 commits into from
Jul 16, 2024
Merged

Docs/Adds Alloy configs #8489

merged 37 commits into from
Jul 16, 2024

Conversation

tacole02
Copy link
Contributor

@tacole02 tacole02 commented Jun 23, 2024 •
edited
Loading

What this PR does

Which issue(s) this PR fixes or relates to

Fixes grafana/alloy#885

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

@CLAassistant
Copy link

CLAassistant commented Jun 23, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

dimitarvdimitrov
dimitarvdimitrov approved these changes Jun 24, 2024
View reviewed changes
Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

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

LGTM, but there's one more mention on line 12. Do you want to change that as well?

@tacole02
Copy link
Contributor Author

Thanks, @dimitarvdimitrov ! This PR is still a draft though, I plan to make a lot more updates before merging :)

@tacole02 tacole02 self-assigned this Jun 24, 2024
@tacole02 tacole02 added the type/docs Improvements or additions to documentation label Jun 24, 2024
@tacole02 tacole02 linked an issue Jun 24, 2024 that may be closed by this pull request
Update Mimir documentation, Agent-->Alloy grafana/alloy#885
Closed
@dimitarvdimitrov
Copy link
Contributor

sounds good. We just don't have an agreed way of treating draft PRs in grafana/mimir, so you might get early reviews

56quarters
56quarters reviewed Jul 12, 2024
View reviewed changes
Copy link
Contributor

@56quarters 56quarters left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Overall this looks like a good change but I'm confused about a bunch of links that were changed. I know @jdbaldry did a lot of work on the linting for links, maybe he can shed some light on the preferred way to do this?

docs/sources/helm-charts/mimir-distributed/get-started-helm-charts/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/configure/configure-native-histograms-ingestion.md Show resolved Hide resolved
docs/sources/mimir/manage/monitor-grafana-mimir/collecting-metrics-and-logs.md Show resolved Hide resolved
clayton-cornell
clayton-cornell approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Some URL updates - result of the recent merge I did in the Alloy docs. The old links will work, but are redirected. The suggested links are the current targets.

docs/sources/helm-charts/mimir-distributed/get-started-helm-charts/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/get-started/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/get-started/_index.md Outdated Show resolved Hide resolved
docs/sources/mimir/manage/monitor-grafana-mimir/collecting-metrics-and-logs.md Outdated Show resolved Hide resolved
docs/sources/mimir/manage/monitor-grafana-mimir/collecting-metrics-and-logs.md Outdated Show resolved Hide resolved
docs/sources/mimir/send/native-histograms/_index.md Show resolved Hide resolved
docs/sources/mimir/send/native-histograms/_index.md Show resolved Hide resolved
docs/sources/mimir/send/native-histograms/_index.md Outdated Show resolved Hide resolved
clayton-cornell
clayton-cornell approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Some URL updates - result of the recent merge I did in the Alloy docs. The old links will work, but are redirected. The suggested links are the current targets.

tacole02 and others added 5 commits July 12, 2024 14:51
@tacole02 @clayton-cornell
Update docs/sources/helm-charts/mimir-distributed/get-started-helm-ch…
402c605 
…arts/_index.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@tacole02 @clayton-cornell
Update docs/sources/mimir/get-started/_index.md
22e815f 
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@tacole02 @clayton-cornell
Update docs/sources/mimir/get-started/_index.md
00b7864 
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@tacole02 @clayton-cornell
Update docs/sources/mimir/manage/monitor-grafana-mimir/collecting-met…
9615abd 
…rics-and-logs.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@tacole02 @clayton-cornell
Update docs/sources/mimir/send/native-histograms/_index.md
0b7e406 
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@jdbaldry
Copy link
Member

Overall this looks like a good change but I'm confused about a bunch of links that were changed. I know @jdbaldry did a lot of work on the linting for links, maybe he can shed some light on the preferred way to do this?

Good callout. Linking advice has changed a few times in the last couple years. https://grafana.com/docs/writers-toolkit/write/links/ has the most up-to-date information. These links look good to me. It basically now boils down to preferring URLs over the relref shortcode because the latter doesn't understand Hugo aliases or redirects.

@tacole02 @krajorama
Update docs/sources/helm-charts/mimir-distributed/run-production-envi…
dba8ddf 
…ronment-with-helm/monitor-system-health.md

Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
@krajorama
Copy link
Contributor

@tacole02 please run make doc and commit the formatting changes to get CI to pass.

@krajorama
Copy link
Contributor

krajorama commented Jul 16, 2024 •
edited
Loading

Overall this looks like a good change but I'm confused about a bunch of links that were changed. I know @jdbaldry did a lot of work on the linting for links, maybe he can shed some light on the preferred way to do this?

Good callout. Linking advice has changed a few times in the last couple years. https://grafana.com/docs/writers-toolkit/write/links/ has the most up-to-date information. These links look good to me. It basically now boils down to preferring URLs over the relref shortcode because the latter doesn't understand Hugo aliases or redirects.

After discussion with @jdbaldry : we noted that having two kinds of versioned reference is not a great idea (MIMIR_DOC_VERSION and MIMIR_VERSION) so we'll change the docs to use MIMIR_VERSION , the official way only in a new PR. In that PR we need to also change how make docs checks out dependencies, since it looks for MIMIR_DOC_VERSION currently. The downside is that CI in Mimir will not be able to verify links, but docs team has a check in place in website to detect broken links after the fact.

The new parameter needs to be cascaded from top in the helm chart doc and also reflected in the RELEASE.md of the chart.

@krajorama krajorama mentioned this pull request Jul 16, 2024
Closed
@krajorama krajorama enabled auto-merge (squash) July 16, 2024 16:31
@krajorama krajorama disabled auto-merge July 16, 2024 16:39
@tacole02
Copy link
Contributor Author

Through discussions with @krajorama , we decided to hold off on backporting these changes to the 2.13 release until #8744 is complete.

@krajorama krajorama merged commit 8082041 into main Jul 16, 2024
29 checks passed
@krajorama krajorama deleted the docs/alloy-885 branch July 16, 2024 17:06
@krajorama krajorama mentioned this pull request Jul 17, 2024
Merged
1 task
@tacole02 tacole02 mentioned this pull request Jul 18, 2024
Merged
4 tasks
grafanabot pushed a commit that referenced this pull request Jul 31, 2024
@tacole02 @grafanabot
Docs/Adds Alloy configs (#8489)
0b87ca0 
Update documentation to refer to Grafana Alloy instead of Grafana Agent.
Updates some links to the new Link style in the writer's toolkit. More to follow in issue #8744 .

Other changes:
Reworking native histograms for improved readability

Co-authored-by: Vladimir Varankin <vladimir.varankin@grafana.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com>
(cherry picked from commit 8082041)
@grafanabot grafanabot mentioned this pull request Jul 31, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krajorama krajorama krajorama approved these changes

@clayton-cornell clayton-cornell clayton-cornell approved these changes

@eamonryan eamonryan Awaiting requested review from eamonryan

@dimitarvdimitrov dimitarvdimitrov Awaiting requested review from dimitarvdimitrov

@narqo narqo Awaiting requested review from narqo

@56quarters 56quarters Awaiting requested review from 56quarters

Assignees

@tacole02 tacole02

Labels
type/docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Mimir documentation, Agent-->Alloy
9 participants
@tacole02 @CLAassistant @dimitarvdimitrov @jdbaldry @krajorama @narqo @56quarters @eamonryan @clayton-cornell