-
Notifications
You must be signed in to change notification settings - Fork 4
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
Improve workflows prerequisite info #221
Conversation
Pull requests must include at least one of the required labels: |
1 similar comment
Pull requests must include at least one of the required labels: |
Pull requests must include at least one of the required labels: |
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.
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?
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. |
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. |
sc-4972/add-slide-with-workflow-prerequisites-to
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:
Output changes
In the developer training module, add a new tab with instructions for verifying the approval workflow:
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:
Replace a very stale image of the default workflow:
External Release Notes