-
Notifications
You must be signed in to change notification settings - Fork 55
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 design docs #1136
docs: add design docs #1136
Conversation
@binbin-li @susanshi I downloaded my Hackmd docs and placed in this folder structure. Unfortunately, the comments are lost but moving forward we can retain via PR review. Please let me know if you think there's a better way. Also, could you both commit your docs to this PR as well? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1136 +/- ##
=======================================
Coverage 52.31% 52.31%
=======================================
Files 101 101
Lines 6306 6306
=======================================
Hits 3299 3299
Misses 2688 2688
Partials 319 319 ☔ View full report in Codecov by Sentry. |
f6ecb96
to
fdabe00
Compare
Just wonder if we should move design docs to this repo or ratify.dev? |
I was modelling off of Gatekeeper. They check in the design docs into the main repository. And it doesn't get published to website. I think it makes sense since we don't want to consider it as official documentation. The design proposals don't necessarily reflect the exact implementation/behavior we have currently. It's more for historical preservation. Having it in the main repo is helpful for keeping it all in one place. Also we might get more feedback on Design PR's if it's on the main repo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for adding it, lgtm!
btw, do we need to open PR merging to your forked branch? |
As maintainers, I think you can just the check the PR out locally and then push to that branch. Either way works. I can also merge this PR and you can send a follow up. |
@binbin-li @susanshi I will merge this PR first. If you could send follow up PRs with your design docs added, that would be great. |
…ratify into akashsinghal/addDesignDocs
Description
What this PR does / why we need it:
adds design doc markdowns from personal hackmd to centralize repo
adds a table of contents
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when the PR gets merged):Fixes #
Type of change
Please delete options that are not relevant.
main
branch)How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration
Checklist:
Post Merge Requirements
Helm Chart Change