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.

Sign up for GitHub

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

Jump to bottom

bug: Broken links in API docs #998

Open

mausch opened this issue Nov 22, 2023 · 1 comment

mausch commented Nov 22, 2023

Describe the issue

https://github.com/fluent/fluent-operator/blob/master/docs/fluentbit.md#outputspec
Links in the "scheme" column are broken.
e.g. opensearch links to https://github.com/fluent/fluent-operator/blob/master/docs/plugins/output/opensearch.md
but the actual URL is https://github.com/fluent/fluent-operator/blob/master/docs/plugins/fluentbit/output/open_search.md

I'm not submitting a PR because these are autogenerated but I don't know where the source is.

To Reproduce

Docs

Expected behavior

Correct links

Your Environment

N/A

How did you install fluent operator?

No response

Additional context

No response

Member

benjaminhuo commented Nov 23, 2023

@mausch Thanks for reporting this. The docs source code are here: https://github.com/fluent/fluent-operator/tree/master/cmd/doc-gen @wanjunlei @wenchajun correct me if I'm wrong

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment