Skip to content

Commit

Permalink
Merge pull request #1293 from shiltemann/training-boxes
Browse files Browse the repository at this point in the history
[Training] update templates to use new, more accessible box style
  • Loading branch information
mvdbeek committed Oct 19, 2022
2 parents 65d79ed + 5366a49 commit 0eee650
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions planemo/training/tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@
HANDS_ON_TOOL_BOX_TEMPLATE = """
## Sub-step with **{{tool_name}}**
> ### {{ '{%' }} icon hands_on {{ '%}' }} Hands-on: Task description
> <hands-on-title> Task description </hands-on-title>
>
> 1. {{ '{%' }} tool [{{tool_name}}]({{tool_id}}) {{ '%}' }} with the following parameters:{{inputlist}}{{paramlist}}
>
> ***TODO***: *Check parameter descriptions*
>
> ***TODO***: *Consider adding a comment or tip box*
>
> > ### {{ '{%' }} icon comment {{ '%}' }} Comment
> > <comment-title> short description </comment-title>
> >
> > A comment about the tool or something else. This box can also be in the main text
> {: .comment}
Expand All @@ -73,12 +73,12 @@
***TODO***: *Consider adding a question to test the learners understanding of the previous exercise*
> ### {{ '{%' }} icon question {{ '%}' }} Questions
> <question-title></question-title>
>
> 1. Question1?
> 2. Question2?
>
> > ### {{ '{%' }} icon solution {{ '%}' }} Solution
> > <solution-title></solution-title>
> >
> > 1. Answer for question1
> > 2. Answer for question2
Expand Down Expand Up @@ -136,7 +136,6 @@

TUTO_HAND_ON_BODY_TEMPLATE = """
# Introduction
{:.no_toc}
<!-- This is a comment. -->
Expand All @@ -163,7 +162,7 @@
[tutorial to learn how to fill the Markdown]({{ '{{' }} site.baseurl {{ '}}' }}/topics/contributing/tutorials/\
create-new-tutorial-content/tutorial.html)**
> ### Agenda
> <agenda-title></agenda-title>
>
> In this tutorial, we will cover:
>
Expand Down Expand Up @@ -195,7 +194,7 @@
## Get data
> ### {{ '{%' }} icon hands_on {{ '%}' }} Hands-on: Data upload
> <hands-on-title> Data Upload </hands-on-title>
>
> 1. Create a new history for this tutorial
> 2. Import the files from [Zenodo]({{ '{{' }} page.zenodo_link {{ '}}' }}) or from
Expand Down Expand Up @@ -235,7 +234,7 @@
***TODO***: *Consider adding a detail box to expand the theory*
> ### {{ '{%' }} icon details {{ '%}' }} More details about the theory
> <details-title> More details about the theory </details-title>
>
> But to describe more details, it is possible to use the detail boxes which are expandable
>
Expand All @@ -253,7 +252,6 @@
Consider merging some hands-on boxes to have a meaningful flow of the analyses*
# Conclusion
{:.no_toc}
Sum up the tutorial and the key takeaways here. We encourage adding an overview image of the
pipeline used.
Expand Down

0 comments on commit 0eee650

Please sign in to comment.