Skip to content

Added a callout for workflow attachment options#503

Merged
validbeck merged 18 commits intomainfrom
beck/sc-7292/documentation-support-attaching-files-on
Nov 7, 2024
Merged

Added a callout for workflow attachment options#503
validbeck merged 18 commits intomainfrom
beck/sc-7292/documentation-support-attaching-files-on

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Nov 1, 2024

Internal Notes for Reviewers

sc-7292

Our workflows & inventory field docs are already pretty comprehensive, so I just added a brief callout to the User Action workflow step reference: LIVE PREVIEW

Screenshot 2024-11-01 at 11 45 34 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Nov 1, 2024
@validbeck validbeck self-assigned this Nov 1, 2024
@validbeck validbeck requested a review from nrichers November 1, 2024 18:56
@validbeck
Copy link
Copy Markdown
Collaborator Author

@cachafla Can you review and approve if it looks good? 🙏🏻

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 4, 2024

PR Summary

This pull request enhances the model workflow guide by adding detailed instructions and visual aids for configuring User Action steps with request fields of type Workflow Attachment. The changes include:

  • A new callout section explaining that all model inventory field types can be included as request fields on a User Action step.
  • Two new screenshots:
    • One showing a User Action step configuration with a request field of Workflow Attachment.
    • Another showing files uploaded under the Workflow Attachment inventory field.
  • An example scenario where an 'In Initial Validation' action requests an upload in the workflow attachment field and transitions the model lifecycle status to 'In Initial Validation'.

These additions aim to provide clearer guidance on setting up and utilizing User Action steps within model workflows.

Test Suggestions

  • Verify that the new callout section is correctly rendered in the guide.
  • Check that the screenshots are displayed properly and match the described configurations.
  • Ensure that the example scenario is clear and accurately reflects the intended workflow setup.
  • Test the guide's instructions by setting up a User Action step with a Workflow Attachment request field in a test environment.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

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.

Nice 👌

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 7, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Copy Markdown
Collaborator Author

@nrichers

FTR, I added .lightbox to the style guide with this PR and applied it where appropriate:

Screenshot 2024-11-07 at 12 50 00 PM

  • I also simplified class="screenshot" to .screenshot across the board as that was more effective.
  • Some neat stacked bubble styling with what was already added to style red/green text for x-marks and check-marks:
    .green-bg {

Screenshot 2024-11-07 at 12 50 57 PM

@validbeck validbeck merged commit 192e085 into main Nov 7, 2024
@validbeck validbeck deleted the beck/sc-7292/documentation-support-attaching-files-on branch November 7, 2024 20:51
@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented Nov 7, 2024

@nrichers

FTR, I added .lightbox to the style guide with this PR and applied it where appropriate:

Thanks!

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