Skip to content
This repository has been archived by the owner on Sep 30, 2020. It is now read-only.

Feature/add new docs #850

Merged
merged 2 commits into from Aug 22, 2017

Conversation

cknowles
Copy link
Contributor

@cknowles cknowles commented Aug 22, 2017

Plan is to host them on github pages but still generate using gitbook CLI.

@mumoshu I tried this out locally and working fine. Now we just need to connect to gh-pages branch we per our discussion.

Plan is to host them on github pages but still generate using gitbook
CLI.
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 22, 2017
@cknowles cknowles requested a review from mumoshu August 22, 2017 11:51
Copy link
Contributor

@mumoshu mumoshu left a comment

Choose a reason for hiding this comment

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

Only minor comment. Otherwise LGTM!

"styles": {
"website": "styles/site.css"
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

AFAIK, the gitbook convention is to place book.json in the project root like I did in https://github.com/mumoshu/kube-aws/blob/master/book.json

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can do, it also means moving things like the .gitignore for node_modules into the root as well and the _book will be generated in the root. In this PR it's all self contained in the docs folder. So if you want to combine them it's possible, are you ok that it will impact these other parts?

Copy link
Contributor

Choose a reason for hiding this comment

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

Good points - Thanks for the confirmation! Yes, I'm ok with those.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did you still want book.json in the root?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes but honestly it's a low priority thing because the reason I want it is just for gitbook compatibility.
We can defer it until gitbook fixes the issue with repos under github orgs.

I'd appreciate it if you could address it though 😉

@codecov-io
Copy link

Codecov Report

Merging #850 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #850   +/-   ##
=======================================
  Coverage   34.49%   34.49%           
=======================================
  Files          57       57           
  Lines        3902     3902           
=======================================
  Hits         1346     1346           
  Misses       2398     2398           
  Partials      158      158

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0dc583e...20a3c8a. Read the comment docs.

@mumoshu mumoshu added this to the v0.9.8-rc.2 milestone Aug 22, 2017
@mumoshu
Copy link
Contributor

mumoshu commented Aug 22, 2017

@c-knowles Thanks for the contribution 👍 I'll try to publish this to gh-pages manually, and the try to automate the process.

@mumoshu mumoshu merged commit c6b6bfa into kubernetes-retired:master Aug 22, 2017
kylehodgetts pushed a commit to HotelsDotCom/kube-aws that referenced this pull request Mar 27, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants