chore(docs): editorial review of transforms and sources #16934
Conversation
maycmlee
requested review from
neuronull,
davidhuie-dd and
spencergilbert
as code owners
✅ Deploy Preview for vrl-playground canceled.
|
✅ Deploy Preview for vector-project ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
github-actions
bot
added
domain: core
Regression Detector ResultsRun ID: 84107f8b-4e0a-4887-a02e-8478e27e99c3 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. No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%. Fine details of change detection per experiment.
|
src/aws/auth.rs
Outdated
| @@ -114,7 +114,7 @@ pub enum AwsAuthentication { | |||
|
|
|||
| /// Timeout for assuming the role, in seconds. | |||
| /// | |||
| /// Relevant when the default credentials chain is used or `assume_role`. | |||
| /// Relevant when the default credentials chain or `assume_role` is used. | |||
There was a problem hiding this comment.
| /// Relevant when the default credentials chain or `assume_role` is used. | |
| /// Relevant when the default credentials chain or `assume_role` is used. |
| @@ -117,7 +117,7 @@ pub struct StreamingConfig { | |||
| #[serde(default = "default_respawn_on_exit")] | |||
| respawn_on_exit: bool, | |||
|
|
|||
| /// The amount of time, in seconds, that Vector will wait before rerunning a streaming command that exited. | |||
| /// The amount of time, in seconds, before rerunning a streaming command that exited. | |||
There was a problem hiding this comment.
| /// The amount of time, in seconds, before rerunning a streaming command that exited. | |
| /// The amount of time before rerunning a streaming command that exited. |
I'll open a PR to add this as an actual unit, which matches how we've been standardizing across the docs.
There was a problem hiding this comment.
@jszwedko do you mind getting someone to update the types and configurable annotations here, or open an issue to to so?
There was a problem hiding this comment.
👍 we can leave this PR as-is for now and circle back to switch these to use types.
There was a problem hiding this comment.
Awesome, thanks @maycmlee !
What is the best way to make sure this copy and new copy stays up-to-date with our style guide? Should we tag you / your team for review on changes? Or just do our best and review it every once in a while (say once a quarter?)? Or something else?
Thanks for reviewing @jszwedko! Yes, tagging the documentation team for review would be best! It'll show up in our on-call PR list and the person on call that day (business hours only) would review it. For for larger reviews, they'd create a docs card and then someone would be assigned to review it. You can also ping in #documentation if you need a quick turnaround. I've made the changes mentioned in the comments, let me know if I've missed anything! |
Regression Detector ResultsRun ID: ebca7705-f688-410e-b5f2-8aa392cd28dc 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. No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%. Fine details of change detection per experiment.
|
Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
github-actions
bot
added
the
domain: external docs
Editorial review of transforms and sources descriptions to fit our style guide.