Skip to content

feat(website): render input and output badges for all components #23204

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
Merged
pront merged 5 commits into from
Jun 16, 2025
Merged

feat(website): render input and output badges for all components #23204

pront merged 5 commits into from
Jun 16, 2025

Conversation

@pront
Copy link
Member

@pront pront commented Jun 13, 2025 •
edited
Loading

Summary

Check the new badges and the new Output Types section in the Remap transform.

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

How did you test this PR?

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the "no-changelog" label to this PR.

Notes

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • The CI checks run only after we manually approve them.
    • We recommend adding a pre-push hook, please see this template.
    • Alternatively, we recommend running the following locally before pushing to the remote branch:
      • cargo fmt --all
      • cargo clippy --workspace --all-targets -- -D warnings
      • cargo nextest run --workspace (alternatively, you can run cargo test --all)
      • ./scripts/check_changelog_fragments.sh
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run cargo vdev build licenses to regenerate the license inventory and commit the changes (if any). More details here.

References

@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jun 13, 2025
@github-actions
Copy link

github-actions bot commented Jun 13, 2025

Your preview site for the VRL Playground will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
VRL Playground preview

@github-actions
Copy link

github-actions bot commented Jun 13, 2025

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jun 13, 2025
@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Jun 13, 2025 •
edited
Loading

Datadog Report

Branch report: pront-website-render-input-output-badges
Commit report: 4a09a06
Test service: vector

✅ 0 Failed, 7 Passed, 0 Skipped, 25.29s Total Time

@github-actions
Copy link

github-actions bot commented Jun 13, 2025

Your preview site for the VRL Playground will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
VRL Playground preview

@github-actions
Copy link

github-actions bot commented Jun 13, 2025

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@pront pront requested a review from thomasqueirozb June 16, 2025 14:46
@pront pront marked this pull request as ready for review June 16, 2025 14:46
@pront pront requested review from a team as code owners June 16, 2025 14:46
@github-actions
Copy link

github-actions bot commented Jun 16, 2025

Your preview site for the VRL Playground will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
VRL Playground preview

@github-actions
Copy link

github-actions bot commented Jun 16, 2025

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

pront
pront commented Jun 16, 2025
View reviewed changes
website/cue/reference/components.cue
Comment on lines +468 to +473
description: string
relevant_when?: string
tags?: #MetricTags
name?: Name
type?: #MetricType
default_namespace?: string
Copy link
Member Author

@pront pront Jun 16, 2025

Choose a reason for hiding this comment

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

We can think about improving this at a second phase.

pront
pront commented Jun 16, 2025
View reviewed changes
website/layouts/partials/data.html
</svg>
</a>
</span>
<div class="mt-3 border rounded divide-y dark:border-gray-700 dark:divide-gray-700">
Copy link
Member Author

@pront pront Jun 16, 2025

Choose a reason for hiding this comment

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

Hmm, I don't remember deleting this but it renders the "?" href just fine.

thomasqueirozb
thomasqueirozb reviewed Jun 16, 2025
View reviewed changes
thomasqueirozb
thomasqueirozb approved these changes Jun 16, 2025
View reviewed changes
website/layouts/partials/logs_output.html
Comment on lines +58 to +85
{{ with $v.description }}
<div class="mt-2 prose dark:prose-dark">
{{ . | markdownify }}
</div>
{{ end }}

{{ range $k, $v := $v.type }}
{{ with $v.examples }}
<div class="mt-2">
<span>
Examples
</span>

<div class="mt-1.5 flex flex-col space-y-1 text-sm">
{{ range . }}
{{ template "code" . }}
{{ end }}
</div>
</div>
{{ end }}
{{ end }}
</div>
{{ end }}
</div>
{{ end }}
</div>
{{ end }}
{{ end }}
Copy link
Contributor

@thomasqueirozb thomasqueirozb Jun 16, 2025

Choose a reason for hiding this comment

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

indentation is a little messed up here

Copy link
Member Author

@pront pront Jun 16, 2025

Choose a reason for hiding this comment

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

I will followup with a PR to add an new formatter for these. They are not simple HTML files. Need a Go template formatter.

@pront pront added this pull request to the merge queue Jun 16, 2025
Merged via the queue into master with commit f41cae2 Jun 16, 2025
145 checks passed
@pront pront deleted the pront-website-render-input-output-badges branch June 16, 2025 18:33
pront added a commit that referenced this pull request Jun 16, 2025
@pront
feat(website): render input and output badges for all components (#23204
9f56921 
)

* feat(website): render input and output badges for all components

* fix badges

* v1 display traces in output data

* remove printfs

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

Reviewers

@thomasqueirozb thomasqueirozb thomasqueirozb approved these changes

@urseberry urseberry urseberry approved these changes

Assignees

No one assigned

Labels

domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pront @thomasqueirozb @urseberry