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 link to new file upload methods #1489

Closed
wants to merge 2 commits into from

Conversation

technically-tracy
Copy link

Summary

Add links to files.upload v2 details.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /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 [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@technically-tracy technically-tracy added the docs M-T: Documentation work only label Apr 5, 2024
Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.34%. Comparing base (f8906fe) to head (008663c).

❗ Current head 008663c differs from pull request most recent head d78e9d9. Consider uploading reports for the commit d78e9d9 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

filmaj
filmaj previously requested changes Apr 5, 2024
docs/web/index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@filmaj filmaj left a 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:

  1. Make your suggested change in the docs-src directory.
  2. Run the doc generation as described in the maintainer's guide.
  3. Commit your changes to docs-src as well as the doc-generation changes to the docs 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.

@WilliamBergamin
Copy link
Contributor

Thank you for the contribution 💯
Yess I believe the changes need to be done in docs-src/, the docs generation script (./scripts/docs.sh) will generate the contents of doc/ from the source code in docs-src/

You can test out your changes in docs-src/ locally by running ./scripts/generate_api_docs.sh

@technically-tracy
Copy link
Author

Thank you both for all the great information! I'll close this PR and try out the steps in the maintainer's guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants