From 5e5f5348a442eeb788d030afbfadbafd8a8f448c Mon Sep 17 00:00:00 2001 From: damien clochard Date: Thu, 22 Aug 2019 17:13:42 +0200 Subject: [PATCH 1/2] [doc] release 19.08 --- CHANGELOG.md | 2 +- NEWS.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++- RELEASING.md | 8 ++--- UPGRADE.md | 9 +----- 4 files changed, 93 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c48724c..0d45bb7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ Changelog =============================================================================== -19.08 - WIP +19.08 ------------------------------------------------------------------------------- __Stack__ diff --git a/NEWS.md b/NEWS.md index 4d16ee4..2c701d0 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,89 @@ +Pandocker 19.08 is out ! +================================================================================ + +Paris, august 22nd + +What is this ? +-------------------------------------------------------------------------------- + +Pandocker is a docker image containing a complete document production toolchain. + +It allows you to generate slides and documents using `pandoc`, but without +installing the required depencies on your machine. + +For instance to generate an EPUB file from a markdown source, you can simply +type: + +``` +docker run --rm -v `pwd`:/pandoc dalibo/pandocker:stable test.md -o test.epub +``` + +This image is available under BSD Licence and it is designed to work without +specific templates. + +The project has 2 main branchs: + +* `dalibo/pandocker:stable` should be used in production ( = 19.08 ) +* `dalibo/pandocker:latest` is the development version + +You can also retrieve images by their version number : `dalibo/pandocker:18.03`, +`dalibo/pandocker:17.12`, etc. + +For more details : + +* Github : +* Docker Hub : + + +What's new in version 19.08 ? +-------------------------------------------------------------------------------- + +### Include code blocks into your documents + +You can now import code for an external file with this simple syntax : + +``` { .sql include=query1.sql} +``` + +To use this plugin, just add `--filter pandoc-codeblock-include` to the command line. + +For more details about this filter, check out [pandoc-codeblock-include]. + +[pandoc-codeblock-include]: https://github.com/chdemko/pandoc-codeblock-include/wiki + + +### Dia + +You can now convert `dia` files to SVG or PNG with the command line below: + +```console +$ docker run [...] --entrypoint dia dalibo/pandocker foo.dia -e foo.svg +``` + +How to upgrade +-------------------------------------------------------------------------------- + +```console +docker pull dalibo/pandocker:stable +``` + +If you installed the toolchain locally, please read: + + + +How to contribute +-------------------------------------------------------------------------------- + +Pandocker is an open project, contributions are welcome. + +If you want to help, you can find a list of "Junior Jobs" here: + + + + + + +--- Pandocker 19.05 is out ! ================================================================================ @@ -41,7 +127,7 @@ What's new in version 19.05 ? ### Include files into your documents -You can now import content for an external markdown file with this simple +You can now import content for an external markdown file with this simple syntax : ``` diff --git a/RELEASING.md b/RELEASING.md index 9dc07a1..05792eb 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -2,11 +2,11 @@ 1. Close all open ticket on the current milestone -2. Update the [CHANGELOG.md] +2. Update the [CHANGELOG.md]() -3. Update the [UPGRADE.md] procedure +3. Update the [UPGRADE.md]() procedure -4. Write a announcement in [NEWS.md] +4. Write a announcement in [NEWS.md]() 5. Add a tag to master @@ -18,5 +18,5 @@ 9. Publish the announcement -10. Update the [CHANGELOG.md] +10. Update the [CHANGELOG.md]() diff --git a/UPGRADE.md b/UPGRADE.md index fe93e2e..20d97f3 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -16,15 +16,8 @@ easier, use the docker image as described above. ### Upgrade from 19.05 to 19.08 -1. FIXME Upgrade Pandoc -```shell -URL=https://github.com/jgm/pandoc/releases/download/2.7/pandoc-2.7-1-amd64.deb -wget -O pandoc.deb $URL -sudo dpkg --install pandoc.deb -``` - -2. Install the codeblock-include filter +1. Install the codeblock-include filter ```shell pip3 install --upgrade -r requirements.txt From ac272fcfa219fa90e5ef79aabc30359d1f3d951a Mon Sep 17 00:00:00 2001 From: damien clochard Date: Thu, 22 Aug 2019 17:28:20 +0200 Subject: [PATCH 2/2] fixup syntax --- NEWS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/NEWS.md b/NEWS.md index 2c701d0..cf250f3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -42,8 +42,10 @@ What's new in version 19.08 ? You can now import code for an external file with this simple syntax : +~~~ ``` { .sql include=query1.sql} ``` +~~~ To use this plugin, just add `--filter pandoc-codeblock-include` to the command line.