-
Notifications
You must be signed in to change notification settings - Fork 91
Add Copyright Acceptance release note #1491
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
Open
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions
53
source/community/release_notes/verawood/copyright_acceptance.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| .. _Verawood Copyright Acceptance: | ||
|
|
||
| Gating Studio Uploads Behind User Agreement Acceptance | ||
| ####################################################### | ||
|
|
||
| Administrators can now configure user agreements that must be accepted before a | ||
| user can access the file or video upload pages for a course in Studio. This | ||
| can be used to gate access to these features behind acceptance of terms and | ||
| conditions, such as a copyright agreement or fair use policy. | ||
|
|
||
| .. note:: | ||
|
|
||
| While this feature does not prevent copyright violations or eliminate risk, | ||
| it gives organizations a transparent way to set expectations, surface policy, | ||
| and log acknowledgment activity as part of their broader governance | ||
| practices. | ||
|
|
||
| Open edX operators remain responsible for ensuring their instances comply | ||
| with applicable laws and regulations in their jurisdictions. | ||
|
|
||
| When configured, users see an alert on the upload page, and the file or video | ||
| management UI is blurred and disabled. Once users accept the agreement, the | ||
| alert disappears and the UI becomes fully available. | ||
|
|
||
| .. figure:: /_images/release_notes/verawood/copyright_acceptance.png | ||
| :align: center | ||
|
|
||
| One or more custom agreements may be displayed on the files and video upload pages within a Studio course. | ||
|
|
||
| You can use the same agreement or different agreements for both pages, and you | ||
| can require multiple agreements for either or both pages. No agreements are | ||
| configured in the default platform unless explicitly set up by an operator. | ||
|
|
||
| The system tracks user acceptance. If an agreement is updated, it prompts users | ||
| to re-accept. | ||
|
|
||
| Site operators should see :ref:`Configure copyright acceptance` to set up this feature on the backend. | ||
|
|
||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`Verawood Product Notes` (reference) | ||
|
|
||
| :ref:`Verawood Dev Notes` (reference) | ||
|
|
||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | 2025-07-30 | OpenCraft | Verawood | Pass | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
source/site_ops/how-tos/configure_copyright_acceptance.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| .. _Configure copyright acceptance: | ||
|
|
||
| Configure User Agreement Acceptance for Studio Uploads | ||
| ******************************************************* | ||
|
|
||
| .. tags:: site operator, how-to | ||
|
|
||
| Setting this up requires two steps: creating the agreement record and then | ||
| configuring where it applies. | ||
|
|
||
| Step 1: Create a UserAgreement | ||
| ============================== | ||
|
|
||
| In the Django admin, go to :guilabel:`/agreements/useragreement/` and create a | ||
| new ``UserAgreement``. Each agreement requires the following fields: | ||
|
|
||
| - **Type** — a unique identifier used to track where this agreement applies | ||
| (for example, ``fair-use-terms`` or ``copyright-assignment``). | ||
| - **Name** and **Summary** — these appear in the alert banner shown to users. | ||
| - **URL** — required; displayed as a **Learn more** link in the alert banner. | ||
|
|
||
| Step 2: Configure Agreement Gating via SiteConfiguration | ||
| ========================================================= | ||
|
|
||
| Configure where the agreement applies using the ``MFE_CONFIG_API`` in | ||
| ``SiteConfiguration``. In the ``MFE_CONFIG`` section, add an | ||
| ``AGREEMENT_GATING`` key. Under it, create a key for each gated feature with | ||
| one or more agreement types that must be accepted. | ||
|
|
||
| The supported feature keys are: | ||
|
|
||
| - ``upload`` — applies to both file and video upload pages | ||
| - ``upload.files`` — applies only to the file upload page | ||
| - ``upload.videos`` — applies only to the video upload page | ||
|
|
||
| For a single agreement, provide the agreement type as a string. For multiple | ||
| agreements, provide a list of type strings. | ||
|
|
||
| Example configuration: | ||
|
|
||
| .. code-block:: json | ||
|
|
||
| { | ||
| "MFE_CONFIG": { | ||
| "AGREEMENT_GATING": { | ||
| "upload": "fair-use-terms", | ||
| "upload.files": "copyright-assignment", | ||
| "upload.videos": [ | ||
| "video-format-agreement" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| In this example: | ||
|
|
||
| - All users uploading files or videos see the ``fair-use-terms`` agreement. | ||
| - Users uploading files also see the ``copyright-assignment`` agreement. | ||
| - Users uploading videos also see the ``video-format-agreement`` agreement. | ||
|
|
||
| Acceptance is tracked by agreement type only, so a user who accepted | ||
| ``fair-use-terms`` on the files page does not need to accept it again on the | ||
| videos page. | ||
|
|
||
| Prompt Users to Re-accept an Updated Agreement | ||
| *********************************************** | ||
|
|
||
| If you update an agreement and need users to re-accept it, update the | ||
| agreement's **updated date** field in the admin panel where you add or edit an | ||
| agreement. Any user who accepted the agreement before that date will be prompted | ||
| to re-accept. | ||
|
|
||
| For changes that don't require users to re-accept the agreement (such as a minor | ||
| spelling correction or formatting fix), you can keep the original update date | ||
| and users won't need to accept it again. | ||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | 2025-07-30 | OpenCraft | Verawood | Pass | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.