Skip to content

Feature: Autogenerate Telegraf docs from influxdata/telegraf repo. #5656

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jstirnaman
Copy link
Contributor

@jstirnaman jstirnaman commented Oct 18, 2024

Adds templates from the telegraf-internal repo to permanently reside in /docs-v2/telegraf-build.

Supports auto-generating Telegraf documentation from the Telegraf release process.
The Telegraf release workflow will trigger the build of a docs binary. When run, the script extracts README file content from the Telegraf release, applies the templates in this PR, and generates a pull request to the docs-v2 repo.

Depends on PR https://github.com/influxdata/telegraf-internal/pull/488

image image

…late frontmatter.

- Use plugin type and version to build related links
- Insert tag list into frontmatter tags
- Rename metadata in content body
@jstirnaman jstirnaman force-pushed the automate-telegraf-docs branch from d5ce256 to 070cbbe Compare March 31, 2025 13:42
@jstirnaman jstirnaman changed the title WIP: Autogenerate Telegraf docs from influxdata/telegraf repo. Feature: Autogenerate Telegraf docs from influxdata/telegraf repo. Mar 31, 2025
@jstirnaman jstirnaman marked this pull request as ready for review March 31, 2025 13:54
@jstirnaman jstirnaman requested a review from sanderson March 31, 2025 16:54
@jstirnaman jstirnaman added this to the Automate Telegraf docs milestone Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants