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: Refactor the online tutorial in difficulty steps and content covered #63

Open
21 tasks
j-opatz opened this issue Jul 3, 2023 · 2 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 priority: high High Priority type: task An actionable item of work

Comments

@j-opatz
Copy link

j-opatz commented Jul 3, 2023

Describe the Task

This task will cover the bulk of the tutorial updates and major overhaul of the tutorial.
As a beginning to the list of improvements, we need to included appropriate references to outside tools for file previewing (ncview, ncdump, wgrib2, etc.) and examples of accessing multiple file types with those tools and METplus. Examples need to progress in difficulty when covering the same topic following the “teach me, show me, let me try” approach. The “let me try” phase should be simple modifications from the “show me” phase with 1 or 2 steps the user has to do. Hints need to be made available so users can solve it if they get stuck.

Time Estimate

5+ 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 priority: high High Priority 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 Refactor the online tutorial in difficulty steps and content covered Tutorial: Refactor the online tutorial in difficulty steps and content covered Jul 3, 2023
@j-opatz
Copy link
Author

j-opatz commented Jul 11, 2023

Part of today's (7/11/2023) METplus engineering meeting was spent discussing the placement of the METplus training videos and RTD presence. Because this area quickly falls out of date and is not as easily updated as text, there was concern of how to proceed with this material.

From the focus group feedback, there were 2 points of input: the first is that most users didn't even know this resource existed. This was due to no advertisement and no links from any of the more known sources (website and User Guides). The second was that while videos were useful, they were seen as better fit for introductory and overview material. Videos that went in depth or over 5 minutes were not useful and difficult to search even with the video text provided.

However, there is a requirement that we keep these videos, in one form or another. Many of the team members believe that the tutorial should be relocated to RTD (a separate issue), as well as keeping the videos out of the website. This could potentially be done, but would require more links and hence more checks to make sure those links don't become broken/outdated.

My preferred route is to migrate the video's material into new videos that outline the beginning of the tutorial sessions, providing an overview and a potential second attempt to reach viewers on a topic. Keeping them isolated in a RTD, even if the embedding aspect can be "more difficult", is part of the problem that leads us to the disparate sources method we're currently in.

@briannen
Copy link

We don't need to do the whole thing at once. We can just refactor one completely from top to bottom (including other issues as needed) as an example.

@j-opatz j-opatz moved this from Todo to In Progress in Focus Group action items Aug 1, 2023
@j-opatz j-opatz moved this from In Progress to Todo in Focus Group action items Mar 8, 2024
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 priority: high High Priority type: task An actionable item of work
Projects
Status: Todo
Development

No branches or pull requests

2 participants