Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

docs: swap example file storage away from deprecated lib #6953

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

stvstnfrd
Copy link
Contributor

The S3BotoStorage backend was deprecated in favor of the S3Boto3Storage backend. This change updates the example backend to reference the latter.

This is meant to accompany openedx/edx-platform#32646

Fixes: FAL-3431
Fixes: public-engineering/128

Configuration Pull Request

Make sure that the following steps are done before merging:

  • A SRE team member has approved the PR if it is code shared across multiple services and you don't own all of the services.
  • Are you adding any new default values that need to be overridden when this change goes live? If so:
    • Update the appropriate internal repo (be sure to update for all our environments)
    • If you are updating a secure value rather than an internal one, file a SRE ticket with details.
    • Add an entry to the CHANGELOG.
  • If you are making a complicated change, have you performed the proper testing specified on the Ops Ansible Testing Checklist? Adding a new variable does not require the full list (although testing on a sandbox is a great idea to ensure it links with your downstream code changes).
  • Think about how this change will affect Open edX operators. Have you updated the wiki page for the next Open edX release?

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 4, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @stvstnfrd! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

⚠️ We can't start reviewing your pull request until you've submitted a signed contributor agreement or indicated your institutional affiliation. Please see the CONTRIBUTING file for more information. If you've signed an agreement in the past, you may need to re-sign. See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed. After this time, you can re-run the CLA check by editing the PR title. If the problem persists, you can tag the @openedx/cla-problems team in a comment on your PR for further assistance.

@stvstnfrd
Copy link
Contributor Author

Note: This work is being done on behalf of OpenCraft and should, presumably, be covered under their CLA agreement.

CC: @openedx/cla-problems

@ChrisChV
Copy link

ChrisChV commented Jul 6, 2023

Looks good +1

  • I read through the changes.

@stvstnfrd stvstnfrd changed the title docs: swap example file storage _away_ from deprecated lib docs: swap example file storage away from deprecated lib Jul 11, 2023
@stvstnfrd
Copy link
Contributor Author

@openedx/cla-problems I've tried re-running the CLA check, but since the runner provides no visual feedback or indicator, I can't tell if it's actually working or not.

Related: Because the CLA check looks like it's been implemented with a webhook and not a Github Action, contributors can't manually rerun the check. If this were implemented with the latter, contributors could re-run the check explicitly, instead of relying on the "edit the title", which is a crude hack. Further, implementing this as a GHA would provide explicit, visual indication that the job was actually rerun (or not).

@stvstnfrd stvstnfrd changed the title docs: swap example file storage away from deprecated lib docs: swap example file storage _away_ from deprecated lib Jul 12, 2023
@stvstnfrd stvstnfrd changed the title docs: swap example file storage _away_ from deprecated lib docs: swap example file storage away from deprecated lib Jul 12, 2023
@pomegranited pomegranited self-assigned this Jul 13, 2023
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 -- this is ready to merge once openedx/edx-platform#32646 merges.

The S3BotoStorage backend was deprecated in favor of the S3Boto3Storage
backend. This change updates the example backend to reference the latter.

Fixes: FAL-3431
Fixes: public-engineering/128
@stvstnfrd
Copy link
Contributor Author

@pomegranited All green and ready to merge.

@pomegranited pomegranited merged commit 898d89b into openedx-unsupported:master Jul 31, 2023
3 checks passed
@stvstnfrd stvstnfrd deleted the fal-3431 branch August 3, 2023 06:08
jdmulloy pushed a commit that referenced this pull request Sep 14, 2023
The S3BotoStorage backend was deprecated in favor of the S3Boto3Storage
backend. This change updates the example backend to reference the latter.

Fixes: FAL-3431
Fixes: public-engineering/128
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants