WIP: Autogenerate Telegraf docs from influxdata/telegraf repo. #5656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a rough first pass at autogenerating Telegraf docs from READMEs in the influxdata/telegraf repo. I expect we'll need to tweak separation of concerns between the two repos and maybe there's a better Hugo-ish approach for templating and leveraging data.
sanderson
reviewed
Oct 18, 2024
build-telegraf/plugins.sh
Outdated
|
|
||
| EOF | ||
| else | ||
| echo "Plugin directory not found: $plugin_dir" |
There was a problem hiding this comment.
We currently have 20 external plugins that are listed on the plugins page but are not part of the Telegraf repo. How do we want to handle these? @srebhan, do you have any thoughts?
| @@ -23,5 +23,6 @@ <h3 id="{{ $type }}-{{ .id }}">{{ .name }}</h3> | |||
| <a class="btn github-link" href="{{ if .link }}{{ .link }}{{ else }}https://github.com/influxdata/telegraf/blob/release-{{ $latestTelegrafVersion }}/plugins/{{ $type }}s/{{ .id }}/README.md{{ end }}" target="_blank"> | |||
| <span class="icon-github"></span> <span class="hide">View</span> | |||
| </a> | |||
| <div>{{ .Site.GetPage "/telegraf/v1/input-plugins/apache/_index.md" }}</div> | |||
There was a problem hiding this comment.
I assume you'll iterate over the page data to do something here?
build-telegraf/plugins.sh
Outdated
| telegraf_v1_ref: | ||
| parent: $parent | ||
| name: $(basename "$plugin_dir") | ||
| tags: [$(basename "$plugin_dir")] |
There was a problem hiding this comment.
One thing that would be nice to account for here is introduced and deprecated versions. Were you thinking we'd do that by injecting frontmatter or adding that frontmatter to the readmes?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a simplistic POC for autogenerating Telegraf docs from READMEs in the influxdata/telegraf repo. I expect we'll need to tweak separation of concerns between the two repos and maybe there's a better Hugo-ish approach for templating and leveraging data.
It doesn't take into account any existing content, like the plugin browse page or previous changes that we might want to port over.