-
Notifications
You must be signed in to change notification settings - Fork 72
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
Add a nox
command that opens the dev docs
#3082
Conversation
Passing run #1462 ↗︎
Details:
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #3082 +/- ##
==========================================
+ Coverage 87.39% 87.54% +0.15%
==========================================
Files 306 307 +1
Lines 17598 17734 +136
Branches 2270 2288 +18
==========================================
+ Hits 15379 15525 +146
+ Misses 1801 1793 -8
+ Partials 418 416 -2
... and 16 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
@allisonking do you think it is worth opening up another issue to tackle the |
oh yeah, those docs are very outdated. yes, let's open another issue and I can go through it 👍 |
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 some of the cleanup here @ThomasLaPiana, learned some nox details while going through this
Yay! That's the goal 😄 |
Closes #3083
Code Changes
contributing
docs (runningnox
naked now opens the documentation page)Developing Fides
pagetesting
andtest environment
pagesdatabase migration
page because there is already a section inDevelopment Tips
Dev Deployment
page because it is now covered byTest Environment
Overview
pageDeveloping Fides
Contributing
fromCommunity
for better visibilitySteps to Confirm
nox -s docs_serve
nox -- dev
. It should open theDeveloping Fides
webpage automagicallyPre-Merge Checklist
CHANGELOG.md
Description Of Changes
This is a much-needed overhaul to our developer documentation that aims to make things more clear and more importantly, guide people in the right direction in terms of "most optimal way to develop". While everyone has different development styles that we want to support, naturally our current setup lends itself better to some ways more than others. This documentation is designed to make that more clear