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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

2 participants