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(vrl): add docs for new timezone option in parse_timestamp function #22121

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

titaneric
Copy link
Contributor

Summary

This is drafted documents for vectordotdev/vrl#1207

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.
  • 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

@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jan 4, 2025
@titaneric titaneric marked this pull request as ready for review January 6, 2025 16:22
@titaneric titaneric requested review from a team as code owners January 6, 2025 16:22
@pront pront added this to the Vector v0.44.0 milestone Jan 6, 2025

{
name: "timezone"
description: "The [TZ database](\(urls.tz_time_zones)) format."
Copy link
Member

Choose a reason for hiding this comment

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

Let's describe a bit more here when this option is useful. You wrote some good context in the issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have tried to add more details to the timezone argument

Copy link
Member

Choose a reason for hiding this comment

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

Thank you, let's wait for a review from the docs team.

@titaneric titaneric requested a review from pront January 6, 2025 18:12
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

Looks good! I just offered a quick suggested edit for the description. 🚀

website/cue/reference/remap/functions/parse_timestamp.cue Outdated Show resolved Hide resolved
@pront pront enabled auto-merge January 6, 2025 19:37
auto-merge was automatically disabled January 7, 2025 02:28

Head branch was pushed to by a user without write access

@titaneric
Copy link
Contributor Author

I have intentionally updated the example without day saving time.

@pront pront enabled auto-merge January 10, 2025 16:49
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 10, 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