Replace gitbook to mdbook
Closes #998 (closed)
What does this MR do?
Adjust gitlab-ci.yml
- Added the docker image from https://github.com/peaceiris/docker-mdbook
mdbook.
Replaced gitbook v1 to- Replaced book.json (because it's deprecated) to book.toml.
Added a docker-compose.docs.yml (included mdbook)
book.json
-
plugin
richquotes
for annotated quotes isn't needed. The result of the rendering has not changed. -
plugin
prism
-highlight for syntax highlighting isn't in mdbook needed. We have to add a programming language to code block. Here is the docu for that.
How confident are you it won't break things if deployed?
Tested localy by gitlab-runner
Links to related issues
https://rust-lang.github.io/mdBook/index.html
How to test
gitlab-runner
- Checkout branch locally
- Install gitlab-runner
- Run command
gitlab-runner exec docker build:docs
in foodsharing repo
docker image
- Checkout branch locally
- Checkout http://localhost:3000 in your browser
- You can find the generated html files in docs/dist
Screenshots (if applicable)
Html-Files
Checklist
-
added a test, or explain why one is not needed/possible... -
no unrelated changes -
asked someone for a code review -
set a "for:" label to indicate who will be affected by this change -
use "state:" labels to track this MR's state until it was beta tested -
added an entry to CHANGELOG.md -
add a short text that can be used in the release notes -
Once your MR has been merged, you are responsible to create a testing issue in Beta Testing Repo: - Consider writing a detailed description in German.
- Describe in a few sentences, what should be tested from a user perspective.
- Also mention different settings (e.g. different browsers, roles, ...). how this change can be tested.
- Be aware, that also non technical people should understand.
Release notes text
(A short text that will appear in the release notes and describes the change for non-technical people. Not always necessary, e.g. not for refactoring.)
Edited by Christian Walgenbach