-
Notifications
You must be signed in to change notification settings - Fork 106
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
Update walk through and user guides #1288
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
6ebbbf1
to
81b674b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1288 +/- ##
=====================================
Coverage 86.2% 86.2%
=====================================
Files 60 60
Lines 4091 4091
Branches 653 653
=====================================
Hits 3530 3530
Misses 391 391
Partials 170 170 ☔ View full report in Codecov by Sentry. |
15aafa2
to
6d156d3
Compare
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 <[email protected]>
6d156d3
to
aaabe25
Compare
- walk-through/pydantic-support.md | ||
- walk-through/hera-developer-features.md | ||
- walk-through/authentication.md | ||
- walk-through/experimental-hera-features.md |
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.
Should this maybe be under "Further Reading"?
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.
I think it's important enough to be top-level in the walkthrough as it tells users about actively developed features. I think it might make sense to just leave the intro paragraph and move the rest to a new "user guide".
I actually wanted to avoid having a "further reading" section because that completely hides the sections and information when opening the page, but the workflow/template features in there aren't really needed in a walkthrough/intro to Hera.
* Also some small formatting fixes Signed-off-by: Elliot Gunton <[email protected]>
e859d8c
to
655911f
Compare
Signed-off-by: Elliot Gunton <[email protected]>
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.
🚀
Pull Request Checklist
Tests addedDocs onlyDescription of PR
Main changes:
before the "authentication" section so users start seeing Hera's unique features
earlier
sections of text to the user guides - new "Integrated Pydantic Support" section
in script-basics.md for the RunnerScriptConstructor