From: Greg Wilson <gvwilson@third-bit.com>
Date: Mon, 9 Jan 2017 20:14:44 +0000 (-0500)
Subject: Adding comments on include files purposes
X-Git-Url: https://git.arvados.org/rnaseq-cwl-training.git/commitdiff_plain/b357f4e769a06ad73db205b57ebb2780f5ea08fe

Adding comments on include files purposes
---

diff --git a/_includes/carpentries.html b/_includes/carpentries.html
index 69e2e1c..c42bfcf 100644
--- a/_includes/carpentries.html
+++ b/_includes/carpentries.html
@@ -1,3 +1,6 @@
+{% comment %}
+  General description of Software and Data Carpentry.
+{% endcomment %}
 <div class="row">
   <div class="col-md-2" align="center">
     <a href="{{ site.swc_site }}"><img src="{{ page.root }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" /></a>
@@ -23,5 +26,3 @@
     building on learners' existing knowledge to enable them to quickly apply skills learned to their own research.
   </div>
 </div>
-
-
diff --git a/_includes/episode_keypoints.html b/_includes/episode_keypoints.html
index 85378a5..2baa53e 100644
--- a/_includes/episode_keypoints.html
+++ b/_includes/episode_keypoints.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Display key points for an episode.
+{% endcomment %}
 <blockquote class="keypoints">
   <h2>Key Points</h2>
   <ul>
diff --git a/_includes/javascript.html b/_includes/javascript.html
index 010ae4a..a2066c2 100644
--- a/_includes/javascript.html
+++ b/_includes/javascript.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Javascript used in lesson and workshop pages.
+{% endcomment %}
 <script src="{{ page.root }}/assets/js/jquery.min.js"></script>
 <script src="{{ page.root }}/assets/js/bootstrap.min.js"></script>
 <script src="{{ page.root }}/assets/js/lesson.js"></script>
diff --git a/_includes/lesson_footer.html b/_includes/lesson_footer.html
index a37ba3e..be46c2d 100644
--- a/_includes/lesson_footer.html
+++ b/_includes/lesson_footer.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Footer for lesson pages.
+{% endcomment %}
 <footer>
   <div class="row">
     <div class="col-md-6" align="left">
diff --git a/_includes/main_title.html b/_includes/main_title.html
index 60b8b06..8e22ced 100644
--- a/_includes/main_title.html
+++ b/_includes/main_title.html
@@ -1 +1,4 @@
+{% comment %}
+  Main title for lesson pages.
+{% endcomment %}
 <h1 class="maintitle"><a href="{{ page.root }}/">{{ site.title }}</a>{% if page.title %}: {{ page.title }}{% endif %}</h1>
diff --git a/_includes/navbar.html b/_includes/navbar.html
index 6a4df8a..effea29 100644
--- a/_includes/navbar.html
+++ b/_includes/navbar.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Lesson navigation bar.
+{% endcomment %}
 <nav class="navbar navbar-default">
   <div class="container-fluid">
     <div class="navbar-header">
diff --git a/_includes/workshop_ad.html b/_includes/workshop_ad.html
index bffe9b9..e8e72e3 100644
--- a/_includes/workshop_ad.html
+++ b/_includes/workshop_ad.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Advertising box at the top of a workshop website home page.
+{% endcomment %}
 <div class="jumbotron">
   <div class="row">
     <div class="col-md-10 col-md-offset-1">
diff --git a/_includes/workshop_footer.html b/_includes/workshop_footer.html
index 31e5f37..c618999 100644
--- a/_includes/workshop_footer.html
+++ b/_includes/workshop_footer.html
@@ -1,3 +1,6 @@
+{% comment %}
+  Footer for a standard workshop.
+{% endcomment %}
 <footer>
   <div class="row">
     <div class="col-md-6" align="left">