dosubot[bot] commented on issue #28353: URL: https://github.com/apache/superset/issues/28353#issuecomment-2101328183
<!-- Answer --> Updating the Apache Superset documentation to reflect the Slack API changes is indeed a crucial step. The deprecation of `files.upload` necessitates a shift to `files.getUploadURLExternal` and `files.completeUploadExternal` for file uploads. This change should be clearly documented to guide new Superset deployments in setting up Slack integrations correctly. For the codebase, transitioning involves: 1. Replacing `files.upload` with `files.getUploadURLExternal` to obtain an upload URL. 2. Uploading the file to this URL, then calling `files.completeUploadExternal` to finalize the upload. This process requires adjustments in error handling and response validation to align with the new Slack API methods. It's essential to ensure the Slack SDK version is compatible and to update any relevant configuration settings in Superset. Contributors can update the documentation by: 1. Setting up a local development environment and making changes in the `./docs` directory. 2. Building and serving a production build of the documentation site for verification. 3. Submitting pull requests with the `docs:` prefix to propose changes. For testing changes to the Slack integration, unit tests with mock objects can verify the functionality without actual Slack API interaction. This approach ensures the integration works as expected under controlled conditions. Finally, notifying Superset users about these important changes involves updating `CHANGELOG.md` and `UPDATING.md`, utilizing community channels like Slack for announcements, and encouraging regular review of the documentation for updates. GitHub can also be used to track issues and updates related to these changes. <!-- Dosu Comment Footer --> <details open> <summary> #### Details </summary> **Sources** - [Using new slack-sdk file upload method.](https://github.com/apache/superset/discussions/28330) - [superset/reports/notifications/slack.py](https://github.com/apache/superset/blob/master/superset/reports/notifications/slack.py) - [superset/tasks/slack_util.py](https://github.com/apache/superset/blob/master/superset/tasks/slack_util.py) - [UPDATING.md](https://github.com/apache/superset/blob/master/UPDATING.md) - [docs/docs/contributing/howtos.mdx](https://github.com/apache/superset/blob/master/docs/docs/contributing/howtos.mdx) - [tests/unit_tests/notifications/slack_tests.py](https://github.com/apache/superset/blob/master/tests/unit_tests/notifications/slack_tests.py) - [RELEASING/release-notes-4-0/README.md](https://github.com/apache/superset/blob/master/RELEASING/release-notes-4-0/README.md) <br/> **About Dosu** This response is meant to be useful and save you time. It is **not meant to be a precise solution**, but rather a starting point for your own research. Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant. </details> *To continue the conversation, mention @dosu.* -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
