docs: add the how to contribute section #27
Merged
Conversation
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
Signed-off-by: chenmiao <chenmiao.ku@gmail.com>
stffrdhrn
reviewed
Sep 2, 2025
|
|
||
| ## How To Contribute | ||
|
|
||
| All pages in the tutorials are built using the Just the Docs format. Therefore, **each Markdown file must include the following YAML configuration at the top**: |
Member
There was a problem hiding this comment.
I think its good to say "Jekyll using the Just the Docs template."
stffrdhrn
approved these changes
Sep 2, 2025
|
|
||
| ### How To Deloyment on Local Env | ||
|
|
||
| To set up a local deployment environment, ensure your system meets the required dependencies. The instructions below are based on an environment: |
Member
There was a problem hiding this comment.
Note, I use Fedora and use rvm (https://rvm.io) to manage my ruby installs. Getting Jekyll is all done via gem. Docs on the Jekyll site. https://jekyllrb.com/docs/usage/
Contributor
Author
There was a problem hiding this comment.
well, I'll add more install instructions for other distributions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Improve the section on how to contribute to tutorials and explain how to locally deploy and verify your contributions.