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

Tutorial: Update and standardize the tutorial icons/text emphasis #61

Open
21 tasks
j-opatz opened this issue Jul 3, 2023 · 5 comments
Open
21 tasks
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: online tutorial Topics related to the METplus Online Tutorial type: task An actionable item of work

Comments

@j-opatz
Copy link

j-opatz commented Jul 3, 2023

Describe the Task

Users found the text changes to be helpful for indicating important aspects, but also noted that they could be overused and distracting when used too much.
To follow more in line with what users thought was a very useful tutorial, we should examine the WRF-ARW tutorial for guidance and see if we can learn from their success.

Time Estimate

2-3 days

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@j-opatz j-opatz added alert: NEED ACCOUNT KEY Need to assign an account key to this issue type: task An actionable item of work component: online tutorial Topics related to the METplus Online Tutorial labels Jul 3, 2023
@j-opatz j-opatz added this to the METplus Future Versions milestone Jul 3, 2023
@j-opatz j-opatz changed the title Update and standardize the tutorial icons/text emphasis Tutorial: Update and standardize the tutorial icons/text emphasis Jul 3, 2023
@briannen
Copy link

The stop sign from the WRF-ARW tutorial is great and should be placed at the top of every session chapter instead of IMPORTANT NOTE.

@briannen
Copy link

Blue box text might be unnecessary.

@briannen
Copy link

Definitely add an icon for what to do when something goes wrong.

@briannen
Copy link

Find an icon to replace the yellow and light gray boxes rather than the color.

@j-opatz j-opatz moved this from Todo to In Progress in Focus Group action items Aug 1, 2023
@briannen
Copy link

briannen commented Aug 3, 2023

Image
Image
Image
Image

These are icon possibilities that I have found.

@j-opatz j-opatz moved this from In Progress to Done in Focus Group action items Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: online tutorial Topics related to the METplus Online Tutorial type: task An actionable item of work
Projects
Status: Done
Development

No branches or pull requests

2 participants