Skip to content
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

Merged
merged 3 commits into from
Dec 11, 2024
Merged

Update walk through and user guides #1288

merged 3 commits into from
Dec 11, 2024

Conversation

elliotgunton
Copy link
Collaborator

Pull Request Checklist

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

@elliotgunton elliotgunton added semver:patch A change requiring a patch version bump type:documentation A documentation update labels Dec 5, 2024
@elliotgunton elliotgunton linked an issue Dec 5, 2024 that may be closed by this pull request
@elliotgunton

This comment was marked as resolved.

Base automatically changed from graduate-script-annotations to main December 5, 2024 23:32
@elliotgunton elliotgunton marked this pull request as ready for review December 6, 2024 09:25
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.2%. Comparing base (93da5f1) to head (2611c69).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@elliotgunton elliotgunton force-pushed the update-walkthrough branch 2 times, most recently from 15aafa2 to 6d156d3 Compare December 9, 2024 10:46
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]>
docs/walk-through/template-features.md Outdated Show resolved Hide resolved
docs/user-guides/script-runner-io.md Outdated Show resolved Hide resolved
docs/user-guides/script-runner-io.md Show resolved Hide resolved
- walk-through/pydantic-support.md
- walk-through/hera-developer-features.md
- walk-through/authentication.md
- walk-through/experimental-hera-features.md
Copy link
Collaborator

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"?

Copy link
Collaborator Author

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]>
Copy link
Collaborator

@alicederyn alicederyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@elliotgunton elliotgunton merged commit 964f400 into main Dec 11, 2024
25 checks passed
@elliotgunton elliotgunton deleted the update-walkthrough branch December 11, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver:patch A change requiring a patch version bump type:documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Walk-through documentation updates
2 participants