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

docs(external): add note for input/output typs in remap docs #22435

Merged
merged 5 commits into from
Feb 13, 2025

Conversation

pront
Copy link
Member

@pront pront commented Feb 13, 2025

Summary

Rephrases and clarifies on event types.

P.S. I also noticed that inputs is not rendered.

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.

Checklist

  • Please read our Vector contributor resources.
    • make check-all is a good command to run locally. This check is
      defined here. Some of these
      checks might not be relevant to your PR. For Rust changes, at the very least you should run:
      • cargo fmt --all
      • cargo clippy --workspace --all-targets -- -D warnings
      • cargo nextest run --workspace (alternatively, you can run cargo test --all)
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run dd-rust-license-tool write to regenerate the license inventory and commit the changes (if any). More details here.

References

Ref: #19508 (comment)

@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Feb 13, 2025
@pront pront requested review from a team as code owners February 13, 2025 21:05
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Feb 13, 2025
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

One nit, but otherwise looks good.

Copy link
Contributor

@bfung bfung left a comment

Choose a reason for hiding this comment

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

editorial suggestions for the remap body text.

@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Feb 13, 2025

Datadog Report

Branch report: pront/remap-docs-improv
Commit report: c854048
Test service: vector

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

@pront pront added this pull request to the merge queue Feb 13, 2025
Merged via the queue into master with commit e878c89 Feb 13, 2025
85 checks passed
@pront pront deleted the pront/remap-docs-improv branch February 13, 2025 23:12
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 no-changelog Changes in this PR do not need user-facing explanations in the release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants