Document Docker usage in README, issue #228 #230
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benoit74
requested changes
Mar 5, 2025
There was a problem hiding this comment.
Some changes:
- we do not want to have a
Usageand aGetting startedsections. I think that it would be much better to rework theGetting startedsection to mention Docker there - pulling the Docker image is useless, do not mention it
- the
-moption is very special in that it creates only one ZIM per language (instead of one ZIM with all requested books). Most users do not want that (they want only one ZIM for their selection of books). Docker instructions should allow to produce a ZIM "available outside of Docker" even when the-moption is not used. Simply mounting/output(which is the default WORKDIR of Docker image where temporary files and final ZIM are placed unless I'm mistaken) as a Docker volume is sufficient for that.
|
I Did the changes. Check if there any mistakes. |
benoit74
requested changes
Mar 6, 2025
benoit74
reviewed
Mar 6, 2025
benoit74
requested changes
Mar 10, 2025
README.md
Outdated
| cd gutenberg | ||
| ``` | ||
|
|
||
| If you do not already have it on your system, install `hatch` to build the software and manage virtual environments (you might be interested by our detailed [Developer Setup](https://github.com/openzim/_python-bootstrap/wiki/Developer-Setup) as well). |
There was a problem hiding this comment.
Please fix link: https://github.com/openzim/_python-bootstrap/blob/main/docs/Developer-Setup.md
(was here before you came as well ...)
end-9214
force-pushed
the
update-readme-docker
branch
from
edefc80 to
478c6fa
Compare
|
@benoit74 I squashed all the commits in one. Please check if correct |
|
Please update your branch to be on-top of latest main commit (and resolve merge conflict, your version is good in fact, it is just a kind of false positive). |
Done, Updated my fork repo :D |
end-9214
force-pushed
the
update-readme-docker
branch
from
478c6fa to
0d1614b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documented Docker usage in README. Closes #228