Skip to content

Conversation

@leakingtapan
Copy link

@leakingtapan leakingtapan commented Sep 13, 2018

add makefile to generate book using docker image for mdbook 0.2.1. With this, people just need to run make doc to generate docs without installing extra rust dependencies

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 13, 2018
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 13, 2018
@leakingtapan
Copy link
Author

leakingtapan commented Sep 13, 2018

/assign @saad-ali

@leakingtapan
Copy link
Author

/assign @lpabon

@pohly
Copy link
Collaborator

pohly commented Sep 13, 2018

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this useful.

@leakingtapan
Copy link
Author

@pohly The reason I add make doc is because the pain I find when fixing the typo. But I also see your point.

Develop can use `make doc` command to generate doc without installing
extra rust dependencies.
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: leakingtapan
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: lpabon

If they are not already assigned, you can assign the PR to them by writing /assign @lpabon in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@leakingtapan
Copy link
Author

@pohly I split the cr. The other one is #51

@pohly
Copy link
Collaborator

pohly commented Sep 14, 2018

@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.

@leakingtapan
Copy link
Author

@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
Copy link
Member

@saad-ali saad-ali Sep 14, 2018

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you elaborate on where is an official location? currently, I host it in my personal dockerhub and source is here

Copy link
Member

@lpabon lpabon left a 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

@lpabon
Copy link
Member

lpabon commented Sep 17, 2018

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.

@lpabon lpabon closed this Sep 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants