Making a publishing workflow

[FilipeRamalho]

With this PR the book is auto-generated through the use of pandadoc and Latex. Each chapter is written in Markdown files, which are rendered to pdf on each commit and a book.pdf is added to the repo.

[jonasgeiler]

Have you tested it? Looks good so far.
@ODXT what do you think?

[FilipeRamalho]

I'm currently doing a last test. 🤞 The rendenring already works, now I'm only testing the Publishing.
Someome would have to make a Travis Build and set the GH_TOKEN variable in Travis.
I don't know why but I can add Travis to the repo, maybe someome who can should do that.

[jonasgeiler]

Can you tell me the enviroment variables so I can add them to travis?
The repo is linked to my travis account somehow

[FilipeRamalho]

You have to make an Auth token on your account and add it on the Dashboard and name the variable GH_TOKEN

[FilipeRamalho]

@skayo I have now access to the Travis repo

[jonasgeiler]

Wait if you are a collaborator can you see travis logs and stuff?

[FilipeRamalho]

@skayo I'm seeing the log

[jonasgeiler]

okay cool

[FilipeRamalho]

This PR was tested and tweaked and works now and is so ready for merging

[ODXT]

I like most of the suggestions here. I'm still unsure about automatically creating the PDF though. Let's check with the others.

[gadilashashank]

How does it render a PDF? I'm sorry but I've got no clue...
Edit: I mean I've got an .md say. Do I have to run any command et.al to generate a PDF.?

[FilipeRamalho]

@gadilashashank It uses the software Pandadoc and TexLive to generate a pdf file

[gadilashashank]

I'm fine with automatic rendering of a PDF. I might sound a bit noob here but is it possible to mention a guide on how to generate PDF from the markdown because atleast I have never done this before..

[jonasgeiler]

@gadilashashank We use travis to automatically convert the md files to one single pdf.
You just commit and it does everything automatically. You don't need to do anything.

[gadilashashank]

@FilipeRamalho great!! As I said earlier I'm fine with this arrangement of automatic PDF generation..

[jonasgeiler]

@FilipeRamalho please wait before merging. I want try GitBook first and see how it is

[FilipeRamalho]

Gitbook would also be option, but can you host it on GitHub or have multiple collaborators.

[FilipeRamalho]

If this solution isn‘t liked I could instead make a service hook on my server to build a pdf on each commit and to host it. Or also make Travis contact the server to only build on successful builds.

[jonasgeiler]

Yes GitBook integrates with GitHub.
Editing on GitBook directly is only for upto 2 Collaborators. But using GitHub you can edit everything here and GitBook just publishes it. With an infinite amount of collaborators (as far as I know) .
Also a PDF download.

[gadilashashank]

Either of the arrangements works but it should be made sure that every edit goes through a review process and random edits are not allowed.
Should a new team called Editors be made?

[jonasgeiler]

Everything happens through pull request so the review happens there. But we could add editors that are responsible for these PRs.

[FilipeRamalho]

We should rather have a maintainer Group which has to confirm the merge and also lint the markdown in travis.

[ODXT]

I apologise for being late to the party.

I originally intended to have the writers review eachothers work (peer review). But having a dedicated team sounds like a good idea.

For now, I'm leaning towards GitBook.
@FilipeRamalho, if we see demand or need to use it in the future, we can open a discussion about it again. Sound good?

[FilipeRamalho]

@ODXT If it works out with Gitbook I'm happy, I will look into @skayo repo and implement that in my PR and push I will notify when it's done.

[ODXT]

I will open up a separate issue to go over the editing team.

[jonasgeiler]

@FilipeRamalho Linting markdown sounds like a good idea! We can definitely do that too.

[FilipeRamalho]

This PR includes now a linting workflow and was also linted. This is again ready for merge.

[ODXT]

Previously approved, but added to officially review.