-
Notifications
You must be signed in to change notification settings - Fork 836
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 link to new file upload methods #1489
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1489 +/- ##
==========================================
- Coverage 85.35% 85.34% -0.01%
==========================================
Files 111 111
Lines 12291 12291
==========================================
- Hits 10491 10490 -1
- Misses 1800 1801 +1 ☔ View full report in Codecov by Sentry. |
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.
Looks good but the source for the docs actually exist under the docs-src/
directory.
More information on this particular setup in the maintainer's guide for this repository.
So I think what you want to do is:
- Make your suggested change in the
docs-src
directory. - Run the doc generation as described in the maintainer's guide.
- Commit your changes to
docs-src
as well as the doc-generation changes to thedocs
directory in this PR.
I think that's how it's supposed to work? @WilliamBergamin / @seratch can you confirm? I am a bit confused about this as well, so maybe it would be good to slightly expand on the doc-generation section of the maintainer's guide to elaborate. For example, it was unclear to me whether the doc generation happens automatically as part of CI/CD or not.
Thank you for the contribution 💯 You can test out your changes in |
Thank you both for all the great information! I'll close this PR and try out the steps in the maintainer's guide. |
Summary
Add links to files.upload v2 details.
Category (place an
x
in each of the[ ]
)/docs-src
(Documents, have you run./scripts/docs.sh
?)/docs-src-v2
(Documents, have you run./scripts/docs-v2.sh
?)/tutorial
(PythOnBoardingBot tutorial)tests
/integration_tests
(Automated tests for this library)Requirements (place an
x
in each[ ]
)python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh
after making the changes.