Update docs for Agent v3.48.0 #2196
Conversation
DrJosh9000
force-pushed
the
jd/agent-release/v3.48.0
branch
from
94018ee
to
adf9e07
Compare
|
Preview URL: https://2196--bk-docs-preview.netlify.app |
DrJosh9000
force-pushed
the
jd/agent-release/v3.48.0
branch
2 times, most recently
from
8bd8950
to
ccdad98
Compare
There was a problem hiding this comment.
tentative accept from me, but probably best to wait for @mbelton-buildkite to weight in
Co-authored-by: Ben Moskovitz <ben.m@buildkite.com>
DrJosh9000
force-pushed
the
jd/agent-release/v3.48.0
branch
from
c4615c9
to
59c1cfd
Compare
pages/agent/v3.md
Outdated
|
|
||
| ## Promoted experiments | ||
|
|
||
| We've recently promoted some experiments into full features. |
There was a problem hiding this comment.
This triggered a couple of things for me:
- Time words like "recently" are tricky in docs so it's good to avoid them.
- This feels like changelog information rather than docs.
BUT, it seems like useful information. Is there anywhere else it could go? Or perhaps just a different heading that doesn't tie it to a time?
There was a problem hiding this comment.
Actually, mentioning the relevant versions like you have, helps. Have we gone through this lifecycle with other experiments? If so, how did they get handled?
There was a problem hiding this comment.
Good question. I thought this might be the first time we've actually "completed" experiments. But it turns out that there is at least one completed experiment present in this file - output-redactor (Redacted variables) was de-experimented in mid 2021 (see buildkite/agent#1452).
Past experiments feels like important documentation to have ("why is my agent printing 'The ansi-timestamps experiment has been promoted...'?") and this seemed like the right page to put it. Perhaps it should be a subsection of "Experimental features"?
There was a problem hiding this comment.
I've left a suggestion for handling this in #2240. Let me know what you think there.
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
* Proposal for promoted agent experiments * Remove emoji update from change
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
No description provided.