Merge pull request #1410 from hexylena/remove-intro-header

remove introduction header from training init
galaxyproject · Nov 20, 2023 · dd49aa1 · dd49aa1
2 parents 1091b1d + 98c8923
commit dd49aa1
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 19 deletions.
diff --git a/planemo/training/tutorial.py b/planemo/training/tutorial.py
@@ -135,9 +135,6 @@
 """
 
 TUTO_HAND_ON_BODY_TEMPLATE = """
-# Introduction
-
-<!-- This is a comment. -->
 
 General introduction about the topic and then an introduction of the
 tutorial (the questions and the objectives). It is nice also to have a
@@ -157,6 +154,7 @@
 [bibliography section](#bibliography) which will automatically be created at the end of the
 tutorial.
 
+<!-- This is a comment. -->
 
 **Please follow our
 [tutorial to learn how to fill the Markdown]({{ '{{' }} site.baseurl {{ '}}' }}/topics/contributing/tutorials/\

diff --git a/tests/data/training_tutorial.md b/tests/data/training_tutorial.md
@@ -16,12 +16,9 @@ contributors:
   - the_best_contributor
 ---
 
-# Introduction
-{:.no_toc}
-
 The introduction
 
-> ### Agenda
+> <agenda-title></agenda-title>
 >
 > In this tutorial, we will deal with:
 >
@@ -32,4 +29,4 @@ The introduction
 
 # First section
 
-# Second section
+# Second section
diff --git a/tests/data/training_tutorial_wo_zenodo.md b/tests/data/training_tutorial_wo_zenodo.md
@@ -16,12 +16,9 @@ contributors:
   - the_best_contributor
 ---
 
-# Introduction
-{:.no_toc}
-
 The introduction
 
-> ### Agenda
+> <agenda-title></agenda-title>
 >
 > In this tutorial, we will deal with:
 >
@@ -32,4 +29,4 @@ The introduction
 
 # First section
 
-# Second section
+# Second section
diff --git a/tests/data/tutorial.md b/tests/data/tutorial.md
@@ -16,12 +16,9 @@ contributors:
   - the_best_contributor
 ---
 
-# Introduction
-{:.no_toc}
-
 The introduction
 
-> ### Agenda
+> <agenda-title></agenda-title>
 >
 > In this tutorial, we will deal with:
 >
@@ -32,4 +29,4 @@ The introduction
 
 # First section
 
-# Second section
+# Second section
diff --git a/tests/test_training_tutorial.py b/tests/test_training_tutorial.py
@@ -316,7 +316,7 @@ def test_tutorial_write_hands_on_tutorial() -> None:
     with open(tuto.tuto_fp) as tuto_f:
         tuto_c = tuto_f.read()
         assert "layout: tutorial_hands_on" in tuto_c
-        assert "# Introduction" in tuto_c
+        assert "<agenda" in tuto_c
         assert "URL1" in tuto_c
         assert "# Conclusion" in tuto_c
     shutil.rmtree("topics")