-
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| .. _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. | ||
|
|
||
| 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. | ||
|
|
||
| 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 | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| .. _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. Any user who accepted the agreement before | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cassiezamparini "updated date" field does not appear anywhere in the docs. What is this and where is it set?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This field is in the admin panel where you add or edit an agreement. The idea is that you increment the updated date then anyone who accepted the agreement before the updated date will have to accept again. For a minor spelling correction or formatting you can keep the original update date and users won't need to accept it again.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It might be useful to just include a screenshot of the admin panel so it's clearer what this page is describing, if possible to provide? |
||
| that date will be prompted to re-accept. | ||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | 2025-07-30 | OpenCraft | Verawood | Pass | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
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.
@cassiezamparini could we add a screenshot or two to this release note?
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.
Here's a screenshot with the agreement.