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

586 dataset terms tab #589

Open
wants to merge 23 commits into
base: develop
Choose a base branch
from
Open

Conversation

ekraffmiller
Copy link
Contributor

@ekraffmiller ekraffmiller commented Jan 29, 2025

What this PR does / why we need it:

Adds the Dataset Page Terms Tab in read only mode

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Step 1: Run the Development Environment

Execute npm i.
Navigate with cd packages/design-system && npm i && npm run build.
Return with cd ../../.
Ensure you have a .env file similar to .env.example, with the variable VITE_DATAVERSE_BACKEND_URL=http://localhost:8000.
Navigate with cd dev-env.
Start the environment using ./run-env.sh unstable.
To verify the environment, visit http://localhost:8000/ and check your local Dataverse installation.

Step 2: Test the feature

  1. Create a Dataset in the SPA and check the terms tab. It should match the JSF terms tab, showing a default license and no additional terms.
  2. In JSF, Go to the terms tab and choose Edit Terms. Add some values to the term fields. Go back to the SPA and view the added terms.
  3. In the JSF, add a file to the dataset and make it restricted. Go to Edit Terms, and add terms of access for the restricted file. Go to the SPA and view the restricted file permissions and terms of access.
  4. In the JSF, go to the Dataset Terms section of the Terms tab, and change the license to Custom Dataset Terms. Then fill in additional input for the custom terms of use. Go to the SPA and view the custom terms.
  5. In the SPA, publish the Dataset, and view the Custom Terms in the Publish Dataset Modal, which should match what is in the terms tab. Check the Custom Terms link in the Publish Dataset Modal, it should link to the Dataset Page in a new browser tab, with the Terms Tab active.
  6. In the SPA, test the Custom Terms link in the Dataset Summary. It should update the Dataset url to include tab=terms, and make the Terms tab active on the page.
  7. View the new stories in Storybook for the Dataset Page, Terms Tab and Publish Dataset Modal.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@ekraffmiller ekraffmiller marked this pull request as ready for review January 29, 2025 14:12
@ekraffmiller ekraffmiller added SPA.Q1.2 Dataset Page: Versions Tab GREI Re-arch GREI re-architecture-related FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) labels Jan 29, 2025
@coveralls
Copy link

coveralls commented Jan 29, 2025

Coverage Status

coverage: 97.307% (+0.03%) from 97.282%
when pulling d14fd40 on feat/586-dataset-terms-tab
into dcdb033 on develop.

@ekraffmiller ekraffmiller added Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 labels Jan 29, 2025
@ekraffmiller ekraffmiller marked this pull request as draft January 29, 2025 20:15
@cmbz cmbz added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 30, 2025
@ekraffmiller ekraffmiller self-assigned this Feb 3, 2025
@ekraffmiller ekraffmiller marked this pull request as ready for review February 10, 2025 14:45
@ekraffmiller ekraffmiller removed their assignment Feb 10, 2025
@ekraffmiller ekraffmiller added Size: 10 A percentage of a sprint. 7 hours. Original size: 10 SPA.Q1.3 Dataset Page: Terms Tab and removed Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 SPA.Q1.2 Dataset Page: Versions Tab labels Feb 10, 2025
@g-saracca g-saracca self-assigned this Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) GREI Re-arch GREI re-architecture-related Original size: 10 Size: 10 A percentage of a sprint. 7 hours. SPA.Q1.3 Dataset Page: Terms Tab
Projects
Status: In Review 🔎
Development

Successfully merging this pull request may close these issues.

Dataset Page: Terms Tab (Read Only Version)
4 participants