Feature/add new docs #850
Feature/add new docs #850
Conversation
Plan is to host them on github pages but still generate using gitbook CLI.
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.
Only minor comment. Otherwise LGTM!
"styles": { | ||
"website": "styles/site.css" | ||
} | ||
} |
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.
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
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 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?
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.
Good points - Thanks for the confirmation! Yes, I'm ok with those.
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.
Did you still want book.json in the root?
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.
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 Report
@@ 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.
|
@c-knowles Thanks for the contribution 👍 I'll try to publish this to gh-pages manually, and the try to automate the process. |
…new-docs Feature/add new docs
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.