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

[pkg/ottl] Updated docs for Time converter #32185

Merged
merged 15 commits into from
Apr 17, 2024

Conversation

michalpristas
Copy link
Contributor

Description:
Updated docs for ottl converter so it includes more information about substitutes users can use

Few examples with timezone handling were added

Link to tracking Issue: #32140

Testing: no testing

Documentation:

@michalpristas michalpristas requested a review from a team April 5, 2024 08:24
@crobert-1 crobert-1 added documentation Improvements or additions to documentation Skip Changelog PRs that do not require a CHANGELOG.md entry labels Apr 5, 2024
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

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

Just formatting nits

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

Please add this under the Time section header:

`Time(target, format`

and then change the reference from time to target.

@github-actions github-actions bot requested a review from kentquirk April 8, 2024 11:21
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

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

Just a couple more nits, but it looks great! Thanks for your patience and for making all of these updates, I really appreciate it!

pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
pkg/ottl/ottlfuncs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@evan-bradley evan-bradley 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 to me outside the open items. Thanks @crobert-1 for giving this a thorough review.

@TylerHelmuth TylerHelmuth added the ready to merge Code review completed; ready to merge by maintainers label Apr 16, 2024
@TylerHelmuth TylerHelmuth merged commit 134c3a8 into open-telemetry:main Apr 17, 2024
156 checks passed
@github-actions github-actions bot added this to the next release milestone Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal/core pkg/ottl ready to merge Code review completed; ready to merge by maintainers Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants