nf-core / nf-core/website

Improve format of Glossary section in Training material guide

Open
#1,626 0 comments 0 reactions 1 assignee View on GitHub

@atoffano is already working on this.

Since Mar 27, 2023.

  • #1678 by @atoffano — closed without merging
documentation first-timers-only hackathon
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

The format of Glossary section can be improved as follows:

  • Learning Objective: A predictive statement describing the specific outcomes that a training session is intended to achieve.
  • Key point: An important take home message.
  • Cognitive load: This relates to the amount of information that working memory can hold at one time.
  • Summative assessment: A way of evaluating the learners progress at the end of a lesson.
  • Fork a repository: This makes a copy of the repository to your personal GitHub workspace.
  • Make a branch: A branch is another version of the files in your repository, including a history of how files were changed from the start of the branch to the current state of files.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.