Update the front page
authorPeter Amstutz <peter.amstutz@curii.com>
Fri, 29 Jan 2021 22:08:34 +0000 (17:08 -0500)
committerPeter Amstutz <peter.amstutz@curii.com>
Fri, 29 Jan 2021 22:08:34 +0000 (17:08 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

README.md
_config.yml
_episodes/01-introduction.md
index.md

index 060994aef38102e7f2b4fdf7196e76ffa9b5dd29..1a6c2abba3b43b9f89aab78a2b52396b378dd5cb 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 [![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/)
 
-This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons. 
+This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons.
 
 ## Contributing
 
@@ -17,17 +17,14 @@ Please see the current list of [issues][FIXME] for ideas for contributing to thi
 repository. For making your contribution, we use the GitHub flow, which is
 nicely explained in the chapter [Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git
 by Scott Chacon.
-Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue.  
+Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue.
 
 
 ## Maintainer(s)
 
-Current maintainers of this lesson are 
-
-* FIXME
-* FIXME
-* FIXME
+Current maintainers of this lesson are
 
+* Peter Amstutz <peter.amstutz@curii.com>
 
 ## Authors
 
index 7ddda3bd1718872e8664a6ed354877e77593c50e..7648b555d2c70c4aa7185f10ca2b1cd0b4c14b9a 100644 (file)
@@ -16,7 +16,7 @@ title: "Getting started with CWL"
 # Life cycle stage of the lesson
 # See this page for more details: https://cdh.carpentries.org/the-lesson-life-cycle.html
 # Possible values: "pre-alpha", "alpha", "beta", "stable"
-life_cycle: "pre-alpha"
+life_cycle: "alpha"
 
 #------------------------------------------------------------
 # Generic settings (should not need to change).
index 81819f92d936fee3e37e8346d136f80080bb485b..fe005cc7c999e4e729f2b62a75b465832e8ac883 100644 (file)
@@ -4,13 +4,11 @@ teaching: 10
 exercises: 0
 questions:
 - "What is CWL?"
-- "What are the requirements for this training?"
 - "What is the goal of this training?"
 objectives:
 - "Understand how the training will be motivated by an example analysis."
 keypoints:
 - "Common Workflow Language is a standard for describing data analysis workflows"
-- "This training assumes some basic familiarity with editing text files, the Unix command line, and Unix shell scripts."
 - "We will use an bioinformatics RNA-seq analysis as an example workflow, but does not require in-depth knowledge of biology."
 - "After completing this training, you should be able to begin writing workflows for your own analysis, and know where to learn more."
 ---
@@ -28,40 +26,16 @@ standard with multiple implementations, CWL is particularly well
 suited for research collaboration, publishing, and high-throughput
 production data analysis.
 
-# Introduction to this training
-
-The goal of this training is to walk the student through the
-development of a best-practices CWL workflow, starting from an
-existing shell script that performs a simple RNA-seq bioinformatics
-analysis.  At the conclusion of this training, you should have a grasp
-of the essential components of a workflow, and have a basis for
-learning more.
-
-This training assumes some basic familiarity with editing text files,
-the Unix command line, and Unix shell scripts.
-
-Specific knowledge of the biology of RNA-seq is *not* a prerequisite
-for these lessons.  Although orignally developed to solve big data
-problems in genomics, CWL is not domain specific to bioinformatics,
-and is used in a number of other fields including medical imaging,
-astronomy, geospatial, and machine learning.  We hope that you will
-find this training useful regardless of your area of research.
-
-These lessons are based on [Introduction to RNA-seq using
-high-performance computing
-(HPC)](https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2) lessons
-developed by members of the teaching team at the Harvard Chan
-Bioinformatics Core (HBC).  The original training, which includes
-additional lectures about the biology of RNA-seq, can be found at that
-link.
-
 # Introduction to the example analysis
 
-RNA-seq is the process of sequencing RNA present in a biological
-sample.  From the sequence reads, we want to measure the relative
-numbers of different RNA molecules appearing in the sample that were
-produced by particular genes.  This analysis is called "differential
-gene expression".
+This training uses a bioinformatics RNA-seq analysis as a motivating
+example.  However, specific knowledge of the biology of RNA-seq is
+*not* required for these lessons.  For those unfamiliar with RNA-seq,
+it is the process of sequencing RNA present in a biological sample.
+From the sequence reads, we want to measure the relative numbers of
+different RNA molecules appearing in the sample that were produced by
+particular genes.  This analysis is called "differential gene
+expression".
 
 The entire process looks like this:
 
@@ -74,8 +48,8 @@ steps (skipping adapter trimming).
 * Alignment (mapping)
 * Counting reads associated with genes
 
-In this training, we are not attempting to develop the analysis from
-scratch, instead we we will be starting from an analysis already
-written in a shell script, which will be supplied in lesson 2.
+In this training, we do not develop the analysis from first
+principals, instead we we will be starting from an analysis already
+written as a shell script, which will be presented in lesson 2.
 
 {% include links.md %}
index 95ccdbdc5491c0babdbfad895d402036c51344fe..4eb5417fb24f32a305b3ecf170eb0574f25ba06d 100644 (file)
--- a/index.md
+++ b/index.md
@@ -3,15 +3,32 @@ layout: lesson
 root: .  # Is the only page that doesn't follow the pattern /:path/index.html
 permalink: index.html  # Is the only page that doesn't follow the pattern /:path/index.html
 ---
-FIXME: home page introduction
 
-<!-- this is an html comment -->
+This training will walk you through the development of a
+best-practices CWL workflow.  At the conclusion of this training, you
+should have a grasp of the essential components of a workflow, and
+have a basis for learning more.
 
-{% comment %} This is a comment in Liquid {% endcomment %}
+These lessons are based on [Introduction to RNA-seq using
+high-performance computing
+(HPC)](https://github.com/hbctraining/Intro-to-rnaseq-hpc-O2) lessons
+developed by members of the teaching team at the Harvard Chan
+Bioinformatics Core (HBC).  The original training, which includes
+additional lectures about the biology of RNA-seq, can be found at that
+link.
 
 > ## Prerequisites
 >
-> FIXME
+> This training assumes some basic familiarity with editing text files,
+> the Unix command line, and Unix shell scripts.
+>
+> Specific knowledge of the biology of RNA-seq is *not* a prerequisite
+> for these lessons.  Although orignally developed to solve big data
+> problems in genomics, CWL is not domain specific to bioinformatics,
+> and is used in a number of other fields including medical imaging,
+> astronomy, geospatial, and machine learning.  We hope that you will
+> find this training useful regardless of your area of research.
+>
 {: .prereq}
 
 {% include links.md %}