Skip to content
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

Merged
merged 18 commits into from
Apr 21, 2023

Conversation

ThomasLaPiana
Copy link
Contributor

@ThomasLaPiana ThomasLaPiana commented Apr 17, 2023

Closes #3083

Code Changes

  • set the default nox session to open the contributing docs (running nox naked now opens the documentation page)
  • add a new Developing Fides page
  • merge the testing and test environment pages
  • update the CSS grid width to take better advantage of available screen space (tables were hardly usable)
  • remove the database migration page because there is already a section in Development Tips
  • remove the Dev Deployment page because it is now covered by Test Environment
  • update the page that talks about writing documentation
  • update the Overview page
  • move debugging info into Developing Fides
  • Unnest Contributing from Community for better visibility

Steps to Confirm

  • run nox -s docs_serve
  • While the local docs are up, run nox -- dev. It should open the Developing Fides webpage automagically
  • inspect the new docs

Pre-Merge Checklist

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

@ThomasLaPiana ThomasLaPiana self-assigned this Apr 17, 2023
@cypress
Copy link

cypress bot commented Apr 17, 2023

Passing run #1462 ↗︎

0 3 0 0 Flakiness 0
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.

Details:

Merge 93ac4e7 into 45e7ab4...
Project: fides Commit: e8bb907f9d ℹ️
Status: Passed Duration: 00:49 💡
Started: Apr 20, 2023 3:50 PM Ended: Apr 20, 2023 3:50 PM

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.

@codecov
Copy link

codecov bot commented Apr 17, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.15 🎉

Comparison is base (5247091) 87.39% compared to head (93ac4e7) 87.54%.

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     
Impacted Files Coverage Δ
.../ops/api/v1/endpoints/consent_request_endpoints.py 86.48% <100.00%> (+2.27%) ⬆️

... 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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ThomasLaPiana ThomasLaPiana marked this pull request as ready for review April 19, 2023 07:41
@ThomasLaPiana
Copy link
Contributor Author

@allisonking do you think it is worth opening up another issue to tackle the UI Development page? I don't know enough there to make changes but it seems outdated? I might be wrong though

@allisonking
Copy link
Contributor

@allisonking do you think it is worth opening up another issue to tackle the UI Development page? I don't know enough there to make changes but it seems outdated? I might be wrong though

oh yeah, those docs are very outdated. yes, let's open another issue and I can go through it 👍

noxfile.py Show resolved Hide resolved
noxfile.py Show resolved Hide resolved
noxfile.py Outdated Show resolved Hide resolved
Copy link
Contributor

@pattisdr pattisdr left a 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

docs/fides/docs/development/code_style.md Show resolved Hide resolved
docs/fides/docs/development/developing_fides.md Outdated Show resolved Hide resolved
docs/fides/docs/development/development_tips.md Outdated Show resolved Hide resolved
docs/fides/docs/development/development_tips.md Outdated Show resolved Hide resolved
@ThomasLaPiana
Copy link
Contributor Author

thanks for some of the cleanup here @ThomasLaPiana, learned some nox details while going through this

Yay! That's the goal 😄

@ThomasLaPiana ThomasLaPiana merged commit dfbf4d4 into main Apr 21, 2023
@ThomasLaPiana ThomasLaPiana deleted the ThomasLaPiana-add-nox-docs-open branch April 21, 2023 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cleanup Dev Docs and add Nox section
5 participants