Skip to content
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

Merged
merged 5 commits into from
Aug 23, 2024

Conversation

yiannistri
Copy link
Contributor

@yiannistri yiannistri commented Aug 20, 2024

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:

  • squashed commits into logical changes
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

@yiannistri yiannistri added the kind/documentation Improvements or additions to documentation label Aug 20, 2024
@yiannistri yiannistri changed the title feat: Add book for CAPRKE2 📖 docs: Add book for CAPRKE2 Aug 20, 2024
@yiannistri yiannistri requested a review from a team August 20, 2024 16:14
Copy link
Contributor

@furkatgofurov7 furkatgofurov7 left a 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.

docs/book/src/introduction.md Outdated Show resolved Hide resolved
docs/book/src/developers/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@furkatgofurov7 furkatgofurov7 left a 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!

Copy link
Member

@alexander-demicev alexander-demicev left a comment

Choose a reason for hiding this comment

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

thanks!

@alexander-demicev alexander-demicev merged commit 89c1c85 into rancher:main Aug 23, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a documentation site
3 participants