Initial work to add a mdbook documentation style #856
Conversation
This file contains 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
Signed-off-by: Jiaxiao (mossaka) Zhou <[email protected]>
Signed-off-by: Doru Blânzeanu <[email protected]>
Signed-off-by: Doru Blânzeanu <[email protected]>
Mossaka
reviewed
Feb 18, 2025
| if: ${{ github.ref == 'refs/heads/main' }} | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./docs/book |
There was a problem hiding this comment.
Does this build the docs on https://containerd.github.io/runwasi/docs/book?
There was a problem hiding this comment.
No, what it does is:
- it generates the
websiteat that path - takes the files and commits them to
gh-pagesbranch which can be selected as source for a Github Page.
The problem is it will use the same URL: https://containerd.github.io/runwasi
So, we need to somehow merge the benchmarks with the book also
I looked briefly for ways to define a different path, but it doesn't seem to work. The only other option would be to use a custom domain
There was a problem hiding this comment.
@devigned FYI - can we use the runwasi.dev website?
4 tasks
jprendes
approved these changes
Feb 21, 2025
| @@ -0,0 +1,6 @@ | |||
| [book] | |||
| authors = ["Runwasi Team"] | |||
There was a problem hiding this comment.
nit:
Suggested change
| authors = ["Runwasi Team"] | |
| authors = ["Runwasi Authors"] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
On top of the work mentioned in #848, this adds a workflow that deploys the documentation on change