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

Vector's doc doesn't properly render array type in component page #22136

Closed
titaneric opened this issue Jan 7, 2025 · 2 comments · Fixed by #22138
Closed

Vector's doc doesn't properly render array type in component page #22136

titaneric opened this issue Jan 7, 2025 · 2 comments · Fixed by #22138
Labels
domain: external docs Anything related to Vector's external, public documentation type: bug A code related bug.

Comments

@titaneric
Copy link
Contributor

A note for the community

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

Problem

Hi,

I notice that metric's field in log_to_metric doc is written but not properly render in the document, and I also notice that static metric suffers the same issue. I find that both their type are array of object, and I suspect the rendering template does not properly handle this case.

I have dug into the issue and find that data.html do not properly render the element of array which prove my guess.

I think I could help to fix this issue!

Configuration

No response

Version

0.43.1

Debug Output

No response

Example Data

No response

Additional Context

No response

References

No response

@titaneric titaneric added the type: bug A code related bug. label Jan 7, 2025
@titaneric titaneric changed the title Vector's doc doesn't properly render **array of object** in component page Vector's doc doesn't properly render array type in component page Jan 7, 2025
@pront pront added the domain: external docs Anything related to Vector's external, public documentation label Jan 7, 2025
@pront
Copy link
Member

pront commented Jan 7, 2025

Thanks @titaneric, this is indeed broken. We will take a look.

@pront
Copy link
Member

pront commented Jan 7, 2025

I have dug into the issue and find that data.html do not properly render the element of array which prove my guess.
I think I could help to fix this issue!

Thank you @titaneric!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: external docs Anything related to Vector's external, public documentation type: bug A code related bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants