Create user documentation - #150
Open
alicefr wants to merge 6 commits into
Open
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Make room for mdBook user documentation by moving developer design artifacts to a dedicated subdirectory. Signed-off-by: Alice Frosi <afrosi@redhat.com>
Set up the mdBook scaffolding with a placeholder introduction page. Add Makefile targets for building and serving docs locally. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Build mdBook and deploy to GitHub Pages on push to main when docs/ changes. This is similarly to what bootc is doing in the main repo. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Signed-off-by: Alice Frosi <afrosi@redhat.com>
Add the introduction for the bootc operator, a summary and introduce the first concepts of the bootc node pool and bootc node. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Include how to create a pool, how to pause and it covers rollback. Signed-off-by: Alice Frosi <afrosi@redhat.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewerAt least 1 approving review is required to merge this pull request.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generate the user documentation following the same model as bootc using mdBook. The first chapter describes the basic operation such as creation a pool, triggering a rollout and pausing the pool.
Fixes: #78