-
Notifications
You must be signed in to change notification settings - Fork 255
add makefile to generate book using docker image of mdbook 0.2.1 #50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
/assign @saad-ali |
|
/assign @lpabon |
|
I don't like commits which contain completely unrelated changes. Can you split out the typo fix and write some better commit messages? Kubernetes is still in the process of more formally defining that (see kubernetes/community#2050) but https://chris.beams.io/posts/git-commit/ is mentioned. |
| # limitations under the License. | ||
|
|
||
| doc: | ||
| docker run --rm -v $(CURDIR):/data -u $(id -u):$(id -g) -it chengpan/mdbook:0.2.1 mdbook build ./book |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this useful.
|
@pohly The reason I add |
Develop can use `make doc` command to generate doc without installing extra rust dependencies.
e4b7af1 to
5814ff8
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: leakingtapan If they are not already assigned, you can assign the PR to them by writing The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
@leakingtapan Thanks. This PR looks good to me. We've had spurious changes in the docs before caused by using slightly different versions of mdbook, so I think this is useful. |
|
@lpabon could you approve the PR since you are the owner |
| # limitations under the License. | ||
|
|
||
| doc: | ||
| docker run --rm -v $(CURDIR):/data -u $(id -u):$(id -g) -it chengpan/mdbook:0.2.1 mdbook build ./book |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you work with @lpabon to get the container chengpan/mdbook:0.2.1 and its source checked in to an official location?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lpabon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
chengpan there is no need for a docker image. mdbook is a single file and has no dependencies
|
I talked to @leakingtapan offline. We concluded with adding a link on the README.md page to his repo for those who do not want to install mdbook and want to use his docker container. |
add makefile to generate book using docker image for mdbook 0.2.1. With this, people just need to run
make docto generate docs without installing extra rust dependencies