Skip to content

Improve workflows prerequisite info #221

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

Merged

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jun 19, 2024

Internal Notes for Reviewers

This PR makes an incremental improvement to our developer and validator training to be more explicit about workflows needing to be configured, which was a review comment from Michael:

  • In the developer training module, add a new tab with instructions for verifying the approval workflow, similar to what the validator training already has. (This fixes an omission in the original training module for developers.)
  • In both the developer and validator training modules, mention that workflows must be set up by an administrator.
  • In the linked-to topic for verifying workflows, add a prerequisite for workflow setup with a link to the new docs for setting up the workflow in the callout, now that those docs are available.
  • Replace a very stale image of the default workflow with an updated version from the current UI

Output changes

  • In the developer training module, add a new tab with instructions for verifying the approval workflow:

    image
  • In both the developer and validator training modules, mention that workflows must be set up by an administrator:

    image
  • In the linked-to topic for verifying workflows, add a prerequisite for workflow setup with a link to the new docs for setting up the workflow in the callout:

    image

Replace a very stale image of the default workflow:

Before After
image image

External Release Notes

Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added the internal Not to be externalized in the release notes label Jun 19, 2024
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

Looks more or less good to me, but I would honestly just remove the screencap under the "Click ... See workflow to visualize the entire workflow that this model will go through." line as Workflows are fully custom, unless you want to tag on a This workflow is custom, and will be configured by an administrator to reflect your team's processes and may not appear like the example below or something like that. My preference is just to remove the image and not overcomplicate things (and saves us time if this default starts to change in the future as it likely will etc.)... especially as there already is a default image in the "Learn more" link!

EDIT: I see now that you single-sourced the instructions that have that default image. Maybe take the image out of the source and leave it on the main page?

@nrichers nrichers changed the title Improve workflow prerequisite info Improve workflows prerequisite info Jun 19, 2024
@nrichers
Copy link
Collaborator Author

I see now that you single-sourced the instructions that have that default image. Maybe take the image out of the source and leave it on the main page?

I'll have to test if this can be made to work as expected. The conditional content itself is not the issue, it's when you try to include conditional content in a numbered list — it tends to reset the numbering regardless of what tricks I've tried. Lemme see what I can do; if it's not possible, I'll just remove the screenshot as suggested.

@validbeck
Copy link
Collaborator

Hm, in my view the image is at the end of the list of instructions so I don't think it will necessarily be an issue but maybe we are looking at different things? 🤔

Before After
Screenshot 2024-06-19 at 3 59 03 PM Screenshot 2024-06-19 at 4 00 07 PM

@nrichers
Copy link
Collaborator Author

Hm, in my view the image is at the end of the list of instructions so I don't think it will necessarily be an issue but maybe we are looking at different things? 🤔

Yes, in fact I just moved the image out into the main topic rather than having it conditionally excluded in the single-sourced content. Problem avoided.

@nrichers nrichers merged commit 5c26e2b into main Jun 19, 2024
2 checks passed
@nrichers nrichers deleted the nrichers/sc-4972/add-slide-with-workflow-prerequisites-to branch June 19, 2024 23:25
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.

2 participants