Skip to content

Commit

Permalink
Merge pull request #108 from dalibo/release_19.08
Browse files Browse the repository at this point in the history
[doc] release 19.08
  • Loading branch information
daamien authored Aug 22, 2019
2 parents 7f666b9 + ac272fc commit 2e9fe77
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
===============================================================================

19.08 - WIP
19.08
-------------------------------------------------------------------------------

__Stack__
Expand Down
90 changes: 89 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,91 @@
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 : <https://github.com/dalibo/pandocker>
* Docker Hub : <https://hub.docker.com/r/dalibo/pandocker/>


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:
<https://github.com/dalibo/pandocker/blob/master/UPGRADE.md#without-docker-local-setup>


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:

<https://github.com/dalibo/pandocker/labels/Junior%20Jobs>




---

Pandocker 19.05 is out !
================================================================================
Expand Down Expand Up @@ -41,7 +129,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 :

```
Expand Down
8 changes: 4 additions & 4 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -18,5 +18,5 @@

9. Publish the announcement

10. Update the [CHANGELOG.md]
10. Update the [CHANGELOG.md]()

9 changes: 1 addition & 8 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2e9fe77

Please sign in to comment.