docs: new features in 3.6 #13739
docs: new features in 3.6 #13739
Conversation
Signed-off-by: Alan Clucas <alan@clucas.org>
Signed-off-by: Alan Clucas <alan@clucas.org>
|
I have also added the features merged since RC-2 |
Signed-off-by: Alan Clucas <alan@clucas.org>
Signed-off-by: Alan Clucas <alan@clucas.org>
docs/features-3.6.md
Outdated
| ## Build and Development | ||
|
|
||
| * [#13000](https://github.com/argoproj/argo-workflows/pull/13000): There is now a `/retest` command for retesting PRs in Github that occasionally fail in a flakey test | ||
| * [#12867](https://github.com/argoproj/argo-workflows/pull/12867): You can supply your own HTTP client when using the go API client, allowing for adding a proxy |
There was a problem hiding this comment.
The API client is an SDK change, so should be under an SDKs section
There was a problem hiding this comment.
SDK stands for software development kit, and this is under development. I don't think we need to split.
There was a problem hiding this comment.
"Build and Development", especially with the first item being a CI thing, makes it sound like items that are only relevant to Contributors, but the SDK is user facing. It's also called an "SDK" in the docs and in our own labels. Similarly, all contributor facing docs are under the "Developer Guide" in the docs.
I definitely don't think we should be creating new names for existing things, that's confusing at best.
SDK stands for software development kit, and this is under development
If you want to debate the difference between denotation and connotation: the connotations are not equivalent in this context, and if you were to use denotation, the entire codebase could be considered "development", so that is not a sufficient boundary
docs/features-3.6.md
Outdated
| ## Build and Development | ||
|
|
||
| * [#13000](https://github.com/argoproj/argo-workflows/pull/13000): There is now a `/retest` command for retesting PRs in Github that occasionally fail in a flakey test |
There was a problem hiding this comment.
dev stuff is not needed and is counter to the stated purpose of having a concise list (and there's plenty we could bikeshed about if we had a dev list)
There was a problem hiding this comment.
This is a new feature and this list is to enable people to discover new features. It isn't needed but I'd like to celebrate it by leaving it in.
There was a problem hiding this comment.
It's in the blog post already, and I think that's sufficient. The blog post includes "non-concise" things.
There are also certainly other new "CI features" if we wanted to call them that, which, as I wrote above, could definitely make for more bikeshedding
There was a problem hiding this comment.
It also is not specific to 3.6 either since it's CI; and that can also make for more bikeshedding
docs/features-3.6.md
Outdated
There was a problem hiding this comment.
relative links to the docs for some of the features here would be really helpful to be able to see them in context when reading this
docs/features-3.6.md
Outdated
| * [#12441](https://github.com/argoproj/argo-workflows/pull/12441): Plugins can now be stopped, so that a stopped workflow will shutdown its plugin nodes | ||
| * The OSS artifact driver: |
There was a problem hiding this comment.
"Plugins" and "Artifacts" sections might be good to split out so it's not just "Controller". Artifacts and Plugins also run in the Server + Executor and Agent, respectively, so not in the Controller
There was a problem hiding this comment.
I've renamed it General. Most people don't care which component a feature happens in, it's an irrelevance to them.
There was a problem hiding this comment.
I don't think that's necessarily accurate -- if I use artifacts, having an "Artifacts" section would make it easy for me to see what's new with that "feature set".
Permissions are also relevant per component. But usage wise, it's less about the "architectural component" and more about the broader "feature set" (or "area" as we use in labels) like "Artifacts", "Plugins", "SSO", "SDKs", "CLI", etc, which is what I suggested above.
You also already did that with the other sections you wrote, such as "UI", "CLI", "Metrics", and "CronWorkflows", so this would be consistent with those existing ones as well.
And in general, I don't think a user would complain about more organization
Signed-off-by: Alan Clucas <alan@clucas.org>
Signed-off-by: Alan Clucas <alan@clucas.org>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org>
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Alan Clucas <alan@clucas.org>
There was a problem hiding this comment.
mkdocs build is giving some warnings on this page:
INFO - Doc file 'new-features.md' contains a link 'upgrading.md#upgrading_to_v3.6', but the doc 'upgrading.md' does not contain an anchor '#upgrading_to_v3.6'.
INFO - Doc file 'new-features.md' contains a link 'upgrading.md#metrics_changes', but the doc 'upgrading.md' does not contain an anchor '#metrics_changes'.
they're logged as INFO though for some reason, so it's not causing a strict error
| This is a concise list of new features. | ||
| For a more detailed list, see the [3.6 blog post](https://blog.argoproj.io/argo-workflows-3-6-aa037cd782be). | ||
|
|
||
| See [the upgrade notes](upgrading.md#upgrading_to_v3.6) for information on breaking changes and deprecations. |
There was a problem hiding this comment.
| See [the upgrade notes](upgrading.md#upgrading_to_v3.6) for information on breaking changes and deprecations. | |
| See [the upgrade notes](upgrading.md#upgrading-to-v36) for information on breaking changes and deprecations. |
- c.f. https://argo-workflows.readthedocs.io/en/release-3.6/upgrading/#upgrading-to-v36
- hyphens are used, not underscores
- that's the canonical / preferred word separator in URLs, see also https://developers.google.com/search/docs/crawling-indexing/url-structure (search "hyphen")
- dot would be invalid in a URL anchor
| * [#13265](https://github.com/argoproj/argo-workflows/pull/13265): The workflow controller can now emit metrics over OpenTelemetry GRPC protocol | ||
| * [#13267](https://github.com/argoproj/argo-workflows/pull/13267): with selectable temporality | ||
| * [#13268](https://github.com/argoproj/argo-workflows/pull/13268): configuration of what is emitted | ||
| * Many of the metrics have been updated which will require you [to change how you use them](upgrading.md#metrics_changes) and there are some new ones: |
There was a problem hiding this comment.
| * Many of the metrics have been updated which will require you [to change how you use them](upgrading.md#metrics_changes) and there are some new ones: | |
| Many of the metrics have been updated which will require you [to change how you use them](upgrading.md#metrics-changes) and there are some new ones: |
- c.f. https://argo-workflows.readthedocs.io/en/release-3.6/upgrading/#metrics-changes
- hyphen, not underscore, same as above
Motivation
Keep users of Argo Workflows well informed of the new features in each release.
Until the next RC is out the feature list is subject to change. This is correct for RC-2 only. This PR will be updated as RC-3 is cut and merged then.
Modifications
Add a features-3.6.md (with the intention that each version will have its own page) with a concise list of all features based around the blog posting. Aiming for less celebratory, more factual.
Update the new features modal for the UI in preparation for 3.6 with a similar summary as per the Kubecon video.
Verification
Validated modal visually and by clicking the links. RTD 3.6 is not yet a thing, but changing to 3.5 for the cron-workflows link works as expected.
Validated new features page here in markdown too.