-
Notifications
You must be signed in to change notification settings - Fork 2k
chore(internal docs): doc::label meta for components, updated descriptions
#16467
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
Conversation
Signed-off-by: Lee Benson <lee@leebenson.com>
✅ Deploy Preview for vrl-playground ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for vector-project canceled.
|
Regression Detector ResultsRun ID: 14da2b16-5e00-45b8-998a-5318568761b8 ExplanationA regression test is an integrated performance test for The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed. Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:
Fine details of change detection per experiment.
|
Signed-off-by: Lee Benson <lee@leebenson.com>
Regression Detector ResultsRun ID: 8dcf0d8c-3465-4324-8e5e-2c4e3cd90af3 ExplanationA regression test is an integrated performance test for The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed. Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:
Fine details of change detection per experiment.
|
sghall
left a comment
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.
Just scanned through the text. Thanks for doing all the components! LGTM 👍
spencergilbert
left a comment
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.
A few requested changes for clarity, several notes - there was also some switching between "a" and "the" for the integration target that we could be more consistent with.
| NewRelic(new_relic::NewRelicConfig), | ||
|
|
||
| /// Papertrail. | ||
| /// Deliver log events to Papertrail from SolarWinds. |
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.
nit (non-blocking): Most of the descriptions were in the form, this one seems like an outlier.
| Socket(socket::SocketConfig), | ||
|
|
||
| /// Splunk HEC. | ||
| /// Receive logs from Splunk. |
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.
note (non-blocking): Perhaps worthwhile differentiating between the cooked/uncooked formats we can support.
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Co-authored-by: Spencer Gilbert <spencer.gilbert@datadoghq.com>
Signed-off-by: Lee Benson <lee@leebenson.com>
Signed-off-by: Lee Benson <lee@leebenson.com>
|
Thanks for the thorough review, @spencergilbert 👍🏻 I've committed the majority of your suggestions and made some additional tweaks. There are a couple I've left alone -- future deprecations, etc. Since we're effectively auto-generating this schema with very minimal post-processing for now, we can remove components as they get retired. Would you mind casting a quick final 👁️? Thank you, sir. |
spencergilbert
left a comment
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.
👍, confirming that changes to these would NOT be a breaking change on your end?
Regression Detector ResultsRun ID: b00a3ec4-c1d1-40b2-9ca6-90e752d15c4b ExplanationA regression test is an integrated performance test for The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed. Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:
Fine details of change detection per experiment.
|
This PR adds new
docs::labelmeta to each component and updates descriptions to match labels used in Cue data (for the most part).The purpose is to disambiguate names from descriptions and give components standard meta in generated schema.
I've taken some liberties with grammar in places, preferring Title Cased names where appropriate and attempting to match brand or product names as they're commonly represented. Feel free to suggest additional changes as necessary. Both names and descriptions will be used in public UI.