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): improve proto codecs docs #22280

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Conversation

pront
Copy link
Member

@pront pront commented Jan 22, 2025

Summary

Added links and examples.

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

@pront pront requested review from a team as code owners January 22, 2025 18:46
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jan 22, 2025
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 22, 2025
@pront pront requested a review from jszwedko January 22, 2025 18:47
Copy link
Member

@jszwedko jszwedko left a comment

Choose a reason for hiding this comment

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

Nice! I think this'll clear up a common question people ask about this codec.

@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Jan 22, 2025

Datadog Report

Branch report: pront/chore-proto-docs
Commit report: 24b0d66
Test service: vector

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

@pront
Copy link
Member Author

pront commented Jan 22, 2025

Needs a rebase on #22223

@pront pront enabled auto-merge January 22, 2025 23:45
@pront pront added this pull request to the merge queue Jan 23, 2025
Merged via the queue into master with commit 17d14d3 Jan 23, 2025
43 checks passed
@pront pront deleted the pront/chore-proto-docs branch January 23, 2025 01:25
pront added a commit that referenced this pull request Jan 24, 2025
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