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: Send Data Alloy page + Interactive Examples #13367

Merged
merged 41 commits into from
Jul 25, 2024
Merged

Conversation

Jayclifford345
Copy link
Contributor

This PR updates the send-data section of the documentation with an Alloy introduction and examples directory. Each of the examples are written as interactive sandboxes using the documentation found here:
https://github.com/grafana/killercoda/blob/staging/docs/transformer.md

Note this PR also includes a new writers shortcut

{{< docs/ignore >}}
{{/< docs/ignore >}}

Here are the Interactive sandboxes auto-generated from the docs:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Documentation contains interactive example
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Jayclifford345 Jayclifford345 added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jul 1, 2024
@Jayclifford345 Jayclifford345 requested a review from a team as a code owner July 1, 2024 15:18
@Jayclifford345
Copy link
Contributor Author

@JStickler I think it's all ready for your review! No rush at all on this. Let me know if any of the new syntax doesn't make sense I can clear it up

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Ran through both tutorials in KillerCoda, but most of my comments are on the Kafka file, even though they apply to both.
Let me know if you have any questions. Nice job on this!

docs/sources/send-data/alloy/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-otel-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-otel-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-otel-logs.md Outdated Show resolved Hide resolved
@Jayclifford345
Copy link
Contributor Author

Hey @JStickler! I added this section to make the language more consistent in opening the configuration file. I have also updated the dev-testing versions of the Killercoda sandboxes to match these changes:
https://killercoda.com/grafana-dev-testing/course/loki/alloy-otel-logs
https://killercoda.com/grafana-dev-testing/course/loki/alloy-kafka-logs

Let me know what you think, many thanks again! Sorry if I missed any of your spelling changes in the other page I think I got them all though

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Almost there!

docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-kafka-logs.md Outdated Show resolved Hide resolved
docs/sources/send-data/alloy/examples/alloy-otel-logs.md Outdated Show resolved Hide resolved
@Jayclifford345
Copy link
Contributor Author

Thanks @JStickler ! That should be those changes added. I have also regenerated the Sandboxes aswell :).

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LGTM

@grafanabot
Copy link
Collaborator

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

1 similar comment
@grafanabot
Copy link
Collaborator

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

@JStickler JStickler merged commit cda7fc8 into main Jul 25, 2024
64 checks passed
@JStickler JStickler deleted the docs-send-data-alloy branch July 25, 2024 15:16
grafanabot pushed a commit that referenced this pull request Jul 25, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit cda7fc8)
grafanabot pushed a commit that referenced this pull request Jul 25, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit cda7fc8)
benclive pushed a commit to cyriltovena/loki that referenced this pull request Jul 31, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
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 release-3.1.x size/XL 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.

4 participants