Generating PDF artefacts of the website

Overview

question Questions
  • How to generate PDF of the different tutorials and slides?

objectives Objectives
  • Generating PDFs

time Time estimation: 10 minutes

Supporting Materials

last_modification Last modification: Feb 20, 2020

Introduction

The website with the training material can be run locally. Sometimes, it is also interesting to freeze the tutorials or to get PDFs of the tutorials.

Agenda

In this tutorial, you will learn how to run a local instance of the GTN website:

  1. Generate PDFs artifact

Generate PDFs artifact

To generate the PDFs, a command make pdf is given. This command:

  • Launches a detached Jekyll server to serve the website
  • Generates the PDFs of the tutorials by calling Chrome via command line
  • Generates the PDFs of the slide decks by calling decktape

hands_on Hands-on: Checking the website generation locally

  1. Install Chrome
  2. Generate the PDFs: make pdf
  3. Check the generated PDFs in _pdf folder

Conclusion

keypoints Key points

  • PDFs can be easily generated for the different tutorials to share with learnees or to keep a fixed version of a tutorial

Feedback

Did you use this material as an instructor? Feel free to give us feedback on how it went.

Click here to load Google feedback frame

Citing this Tutorial

  1. Bérénice Batut, 2020 Generating PDF artefacts of the website (Galaxy Training Materials). /training-material/topics/contributing/tutorials/generating-pdf/tutorial.html Online; accessed TODAY
  2. Batut et al., 2018 Community-Driven Data Analysis Training for Biology Cell Systems 10.1016/j.cels.2018.05.012

details BibTeX

@misc{contributing-generating-pdf,
    author = "Bérénice Batut",
    title = "Generating PDF artefacts of the website (Galaxy Training Materials)",
    year = "2020",
    month = "02",
    day = "20"
    url = "\url{/training-material/topics/contributing/tutorials/generating-pdf/tutorial.html}",
    note = "[Online; accessed TODAY]"
}
@article{Batut_2018,
        doi = {10.1016/j.cels.2018.05.012},
        url = {https://doi.org/10.1016%2Fj.cels.2018.05.012},
        year = 2018,
        month = {jun},
        publisher = {Elsevier {BV}},
        volume = {6},
        number = {6},
        pages = {752--758.e1},
        author = {B{\'{e}}r{\'{e}}nice Batut and Saskia Hiltemann and Andrea Bagnacani and Dannon Baker and Vivek Bhardwaj and Clemens Blank and Anthony Bretaudeau and Loraine Brillet-Gu{\'{e}}guen and Martin {\v{C}}ech and John Chilton and Dave Clements and Olivia Doppelt-Azeroual and Anika Erxleben and Mallory Ann Freeberg and Simon Gladman and Youri Hoogstrate and Hans-Rudolf Hotz and Torsten Houwaart and Pratik Jagtap and Delphine Larivi{\`{e}}re and Gildas Le Corguill{\'{e}} and Thomas Manke and Fabien Mareuil and Fidel Ram{\'{\i}}rez and Devon Ryan and Florian Christoph Sigloch and Nicola Soranzo and Joachim Wolff and Pavankumar Videm and Markus Wolfien and Aisanjiang Wubuli and Dilmurat Yusuf and James Taylor and Rolf Backofen and Anton Nekrutenko and Björn Grüning},
        title = {Community-Driven Data Analysis Training for Biology},
        journal = {Cell Systems}
}
                    

congratulations Congratulations on successfully completing this tutorial!

Developing GTN training material

This tutorial is part of a series to develop GTN training material, feel free to also look at:
  1. Overview of the Galaxy Training Material
  2. Contributing with GitHub via command-line
  3. Contributing with GitHub via its interface
  4. Creating a new tutorial
  5. Creating a new tutorial - Creating Interactive Galaxy Tours
  6. Creating a new tutorial - Defining the technical infrastructure
  7. Creating a new tutorial - Slides
  8. Creating a new tutorial - Writing content in Markdown
  9. Generating PDF artefacts of the website
  10. Including a new topic
  11. Running the Galaxy Training material website locally