Skip to content

Added instructions for Wait steps in workflows#628

Merged
validbeck merged 3 commits intomainfrom
beck/sc-7615/documentation-support-for-wait-steps
Jan 16, 2025
Merged

Added instructions for Wait steps in workflows#628
validbeck merged 3 commits intomainfrom
beck/sc-7615/documentation-support-for-wait-steps

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Jan 16, 2025

Internal Notes for Reviewers

sc-7615

Manage model inventory fields

LIVE PREVIEW

Added some clarification on timezone/displays under Inventory field types for these fields as they were missing before.

Screenshot 2025-01-16 at 10 51 51 AM

Set up model workflows

LIVE PREVIEW

New Wait step under Available step types:

Screenshot 2025-01-16 at 10 50 52 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Jan 16, 2025
@validbeck validbeck self-assigned this Jan 16, 2025
@validbeck
Copy link
Copy Markdown
Collaborator Author

@cachafla or @panchicore Can you review the following and let me know if it looks good? If so pls approve 🙏🏻

Set up model workflows

Old lead-in text before Available step types for context:

Screenshot 2025-01-16 at 10 51 34 AM

New Wait step type:

Screenshot 2025-01-16 at 10 50 52 AM

Manage model inventory fields

Clarification on timezone/displays under Inventory field types for these fields:

Screenshot 2025-01-16 at 10 51 51 AM

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request introduces several enhancements to the model inventory management and workflow configuration documentation. The key changes include:

  1. Model Inventory Fields:

    • Updated the description for Date and Date Time fields to clarify that the selection is in the current user's timezone, and other users will see the value in their timezone.
  2. Workflow Configuration:

    • Corrected a typo from "module" to "modal" in the instructions for configuring a condition branch.
    • Added a new section titled "Wait" that describes how to create a time condition for displaying the next available action. This includes options for waiting after a time interval, until a specified date, or until a specified date on a model field.
    • Updated footnotes and references to ensure accuracy and clarity in the workflow setup instructions.

These changes aim to improve the clarity and usability of the documentation for users managing model inventories and setting up workflows.

Test Suggestions

  • Verify that the documentation correctly reflects the timezone behavior for Date and Date Time fields.
  • Check the updated instructions for configuring a condition branch to ensure the term 'modal' is used correctly.
  • Test the new 'Wait' step configuration options to ensure they are accurately described and function as expected in the workflow.
  • Review all footnotes and references to confirm they link to the correct sections and provide accurate information.

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request introduces several enhancements to the model inventory and workflow configuration documentation:

  1. Model Inventory Fields:

    • Updated the description for Date and Date Time fields to clarify that the selection is in the current user's timezone, and other users will see the value in their timezone.
  2. Workflow Configuration:

    • Corrected a typo from "module" to "modal" in the instructions for configuring a condition branch.
    • Added a new section titled "Wait" that describes how to create a time condition for displaying the next available action. This includes options for waiting after a time interval, until a specified date, or until a specified date on a model field.
    • Updated footnotes and references to ensure accuracy and clarity in the workflow setup instructions.

These changes aim to improve the clarity and functionality of the documentation, ensuring users have a better understanding of how to manage model inventory fields and configure workflows effectively.

Test Suggestions

  • Verify that the updated descriptions for Date and Date Time fields correctly reflect timezone behavior in the application.
  • Test the workflow configuration process to ensure the 'Wait' step functions as described, including all options for time intervals and specified dates.
  • Check the documentation for any remaining typos or inconsistencies, especially in the updated sections.
  • Ensure that all footnotes and references are correctly linked and provide accurate information.

Copy link
Copy Markdown
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Awesome 🫡

@validbeck validbeck merged commit 29c9373 into main Jan 16, 2025
@validbeck validbeck deleted the beck/sc-7615/documentation-support-for-wait-steps branch January 16, 2025 19:32
@panchicore
Copy link
Copy Markdown
Member

beautiful 🕐

validbeck added a commit that referenced this pull request Jan 22, 2025
* Add make execute PROFILE=exe-prod to docs-site action  (#598)

* Add execute PROFILE=exe-prod to Docker image build

* Move notebook execution into docs-site action

* Docs — Customize model overview page (#622)

* Draft customize-model-overview-page.qmd

* Quick instructions

* Edits based on feedback from Rod

* Updated docs — Workflows (#620)

* Tweak to release generation notebook

* Wait, gotta make the file first

* Wording in notebook

* Just being picky about spaces now

* Adding open file to yearly_cleanup.py too

* Success

* Edits to customize-model-lifecycle-statuses.qmd

* New img - working-with-model-workflows.qmd > See workflow statuses

* +reset-workflow.gif to working-with-model-workflows.qmd

* Updated set-up-model-workflows.qmd > Configure workflow steps

* Updated configure-user-action.png

* Updated approval-group-setup.png

* Redid the Approval Step example/images

* Redid the Condition Branch example/images

* Changed linked-workflow image to a gif

* Updated set-up-model-workflows.qmd > Link approval steps

* Changed my mind about the model-workflows.png screencap

* Tweak

* Simplifying based on Rod's suggestion

* QoL improvements to release notes script/notebooks (#626)

* Testing adding the year to generated release notes

* oops, forgot to parse the date format

* Now the folder is swapped ugh

* Adding the year to the _quarto.yml entry

* Oops, forgot to add the input

* Casing

* Adding new year folder to index function

* Grabbing yearly folders in established year

* Fake 2025 releases for testing & modifying Makefile command

* Fake 2026 release for yearly cleanup test

* Trying the yearly lookup again

* Yearly lookup works

* Retrieve year folder

* Commenting out move releases for now

* Removed move releases

* Modifying update_quarto_yaml

* Cleaning up the Makefile command

* Notebook wording cleanup

* Removing test files & reverting _quarto.yml & index.qmd to main

* Added aliases for moved 2024 releases

* Added aliases for moved 2023 releases

* Whoops, wrong alias for some of the super old releases

* Nitpicky edit

* Meh

* Nitpicking the output

* Added instructions for Wait steps in workflows (#628)

* Edits to date & date-time custom fields

* Wait step draft

* Edits & footnotes

---------

Co-authored-by: Nik Richers <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants