Merge pull request #217 from NLeSC/pdf

Generate PDF

Author: sverhoeven

.docsifytopdfrc.yml

@@ -0,0 +1,3 @@
+contents:
+  - _sidebar.md
+pathToPublic: guide-nlesc.pdf

.github/workflows/pdf.yml

@@ -0,0 +1,24 @@
+name: Generate PDF
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Change absolute paths to relative
+        run: perl -pi -e 's@\]\(\/@\]\(@' _sidebar.md
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - name: Install converter + uploadergit
+        run: npm install docsify-pdf-converter @iomeg/zenodo-upload
+      - name: Generate PDF
+        run: npx docsify-pdf-converter
+      - name: Upload PDF to Zenodo
+        run: npx --package @iomeg/zenodo-upload zenodo_upload 4020565 guide-nlesc.pdf "${github_ref:10}" ${{ secrets.ZENODO_TOKEN }}
+        env:
+          github_ref: ${{ github.ref }}

CONTRIBUTING.md

@@ -41,3 +41,8 @@ If you have made a significant contribution to the guide, please make sure to ad
 ## Chapter Owners
 
 To see who is responsible for which part of the guide see [chapter_owners.md](chapter_owners.md).
+
+## Create a PDF file
+
+We host a PDF version of the guide on [Zenodo](https://doi.org/10.5281/zenodo.4020565).
+To update it a [new release](https://github.com/NLeSC/guide/releases) needs to be made of the guide. This will trigger a GitHub action to create a new Zenodo version with the PDF file.

README.md

@@ -1,4 +1,5 @@
 Dead-link checker status (does not actually build guide itself): [![Build Status](https://travis-ci.org/NLeSC/guide.svg?branch=master)](https://travis-ci.org/NLeSC/guide)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4020565.svg)](https://doi.org/10.5281/zenodo.4020565)
 
 # Guide
 
@@ -11,3 +12,5 @@ Read this book online here: https://guide.esciencecenter.nl
 If you would like to contribute to this book see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 To see who is responsible for which part of the guide see [chapter_owners.md](chapter_owners.md).
+
+The guide is best read online, but there is a [PDF document](https://doi.org/10.5281/zenodo.4020564) for offline reading.