Walk-through documentation updates #1273
Assignees
Labels
type:documentation
A documentation update
Comments
elliotgunton
changed the title
set_class_defaults usage to docs
4 tasks
4 tasks
sambhav
pushed a commit
that referenced
this issue
Dec 5, 2024
**Pull Request Checklist** - [x] Fixes #1286 - [x] Tests updated - [x] Documentation/examples updated - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Graduate script annotations * Users no longer need to set the `experimental_features["script_annotations"]` flag * We no longer add the `hera__script_annotations` environment variable to scripts, so no longer need to check it in the runner `util.py` code * Update documentation and examples - I am intending to follow this PR with a review/rearranging of the walk through section, which will also address #1273 With this change, the default code path becomes the "script annotations" path, so we always check for `Annotated`, rather than using simple kwarg checks, so we are able to remove the `_get_parameters_from_callable` function. --------- Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
elliotgunton
added a commit
that referenced
this issue
Dec 11, 2024
**Pull Request Checklist** - [x] Fixes #1273 - [ ] ~Tests added~ Docs only - [x] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Main changes: * Surface the "hera developer features" walk through section in the walk through before the "authentication" section so users start seeing Hera's unique features earlier * Added the "Set class defaults" section here * Separate out the experimental features into its own section as it's big enough * Rename the "advanced features" section to "further reading" to be less scary * Remove the under-utilised Pydantic integration section, move relevant sections of text to the user guides - new "Integrated Pydantic Support" section in script-basics.md for the RunnerScriptConstructor * Add more motivation to the Runner IO to make it more obvious why it's needed --------- Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
#1271 is already possible but not obvious from the docs, https://hera.readthedocs.io/en/stable/examples/workflows/misc/global_config/ is the only example.
Currently,
set_class_defaultsitself is also not searchable in the docs:And does not appear in the Pre-build hooks section - consider renaming the section to drop "advanced" and make a new walk through section for hera-specific features (i.e. things that are not a 1-1 mapping from Argo Workflows).
The text was updated successfully, but these errors were encountered: