-
Notifications
You must be signed in to change notification settings - Fork 37
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
documentation website setup #64
Merged
Merged
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
size-limit report 📦
|
Codecov Report
@@ Coverage Diff @@
## main #64 +/- ##
=======================================
Coverage 93.85% 93.85%
=======================================
Files 14 14
Lines 244 244
Branches 29 29
=======================================
Hits 229 229
Misses 14 14
Partials 1 1
Continue to review full report at Codecov.
|
fuxingloh
requested review from
fullstackninja864,
monstrobishi,
saurabh391,
thedoublejay and
uzyn
March 15, 2021 08:57
thedoublejay
approved these changes
Mar 16, 2021
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.
What kind of PR is this?:
/kind docs
What this PR does / why we need it:
Implements a documentation static website for jellyfish alongside the code. Currently, there are 3 main section of documentation. I used https://v2.docusaurus.io/ a static website generator powered by react + markdown. As markdown is how the content get created, the ssg used is quite a trival decision.
The docs structure:
Which issue(s) does this PR fixes?:
Fixes #20
Additional comments?:
2 issues are created/separated to track the progress of website:
This is how it looks like now for preview since, I have not created the workflow for automatic preview builds.