-
Notifications
You must be signed in to change notification settings - Fork 30
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
📖 docs: Add book for CAPRKE2 #409
Conversation
deedddd
to
1428d9f
Compare
a7dd63b
to
18def66
Compare
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.
Thanks for putting this together @yiannistri, this serves as a foundation for the provider book in the future.
I know we lack documentation in this repo and should do better, however, may I ask you to have a simple structure for the book (or even similar to https://cluster-api-operator.sigs.k8s.io/ for inspiration) so in the future we can document more stuff in the corresponding folders of the book. We can start simple, having a basic skeleton that is kind of similar to the upstream ones but extendable, is all I am after here.
PS. mdbook setup seems to be working and serving the book properly when trying it locally.
916af64
to
5a81243
Compare
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.
Great job @yiannistri, this version as a base of the provider book,LGTM!
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.
thanks!
What this PR does / why we need it:
This PR adds a book for CAPRKE2. As part of this PR, I have moved the getting started and the developer guide from README.md into the book and provided links to the relevant pages instead. I have also added support for using the
embed-github
syntax for convenience although it has not yet been used. Finally, I have added a GHA workflow that deploys the book to GitHub Pages.Which issue(s) this PR fixes:
Fixes #92
Special notes for your reviewer:
You can run
cd ./docs/book && make serve
from the root of the project to be able to view the book using your browser.Checklist: