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

Fix links #2664

Merged
merged 4 commits into from
Jun 27, 2024
Merged

Fix links #2664

merged 4 commits into from
Jun 27, 2024

Conversation

JakeSCahill
Copy link
Collaborator

@JakeSCahill JakeSCahill commented Jun 18, 2024

Fixes #2663

@JakeSCahill JakeSCahill mentioned this pull request Jun 18, 2024
Copy link
Collaborator

@Jeffail Jeffail left a comment

Choose a reason for hiding this comment

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

Just one comment, don't worry about the zmq issues, it's because the docs generator by default doesn't include ZMQ components by default (it requires cgo and the zmq lib installed). I'll fix that after review changes.

@@ -61,9 +61,12 @@ Introduced in version {{.Version}}.
THIS FILE IS AUTOGENERATED!

To make changes please edit the contents of:

https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/bloblang_functions.adoc.tmpl

https://github.com/redpanda-data/benthos/tree/main/internal/bloblang/query/functions.go
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should remove any links that aren't the templates within docs_gen/templates, and then maybe add a general "Or the source of the plugin itself" after the template link. Do this for all the templates, otherwise we're going to be constantly leading people into stale links and/or the wrong repos.

@JakeSCahill JakeSCahill requested a review from Jeffail June 18, 2024 18:47
Copy link
Collaborator

@Jeffail Jeffail left a comment

Choose a reason for hiding this comment

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

LGTM

@Jeffail Jeffail merged commit df6f918 into main Jun 27, 2024
2 checks passed
@Jeffail Jeffail deleted the JakeSCahill-patch-2 branch June 27, 2024 08:02
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.

Docs typo in Configuration: Templating
2 participants