-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
[processor/transform] more readme refactoring #37909
[processor/transform] more readme refactoring #37909
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall I really like this. I'd be fine moving forward without any of the larger changes I suggested, we can always iterate later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks great! I liked the new format and extra OTTL section.
Co-authored-by: Evan Bradley <[email protected]>
Co-authored-by: Edmo Vamerlatti Costa <[email protected]> Co-authored-by: Evan Bradley <[email protected]>
It's getting great! I liked @evan-bradley suggestion, but reading the docs it's still feel we're introducing new concepts, but now with different names "Flat configuration" -> "Basic Config", and "Structured configuration" -> "Advanced Configuration". I'm wondering if we should focus on the statements configuration part instead, so it wouldn't feel those styles are completely different configuration formats, for example: TylerHelmuth/opentelemetry-collector-contrib@transform-continue-readme-refactor...edmocosta:opentelemetry-collector-contrib:patch-1 |
I was hoping that at least with terms like "basic" or "advanced" configuration users would have some pre-existing idea of what those mean, but I agree we should try to make them feel like the same thing. I like what you're going for, but I think I would tweak it just slightly and say something like this: The Transform Processor's main config section is a list of things for the processor to execute. The list can contain:
I think if we frame it as "diving deeper" instead of making a choice between two styles they will feel like a single thing. |
Co-authored-by: Edmo Vamerlatti Costa <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for improving the docs!
There was a problem hiding this 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. This is a big improvement for the docs.
Co-authored-by: Evan Bradley <[email protected]>
Description
With the new context inference feature the user needs to know less about the concept of an OTTL Context. This refactor restructures the README some more to try really hard not to talk about OTTL context and instead talk about OTTL Paths, which is the concrete thing the user needs to know to write an OTTL statement.
Link to tracking issue
#29017