Skip to content

Tutorial: Update the tutorial to include more links to and from the User Guides #62

@j-opatz

Description

@j-opatz

Describe the Task

One of the biggest complaints of the online tutorial was that it attempted to cover too much information while not allowing a good coverage of the material it was trying to cover. By linking to the User’s Guides from the tutorial for more information on the tools being used/settings, we can remove the need for an in-depth discussion in the tutorial, “lightening up” the tutorial in the process as well as getting tutorial users to quickly navigate to the important information in the User’s Guide. Similarly, links from the User’s Guides to the tutorial will allow users who ended up in the User’s Guides looking for examples/help to be guided to examples that show the tool “in action”.

Time Estimate

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.

Metadata

Metadata

Type

No type

Projects

Status

Todo

Relationships

None yet

Development

No branches or pull requests

Issue actions