Skip to content

Conversation

@ekraffmiller
Copy link
Contributor

What this PR does / why we need it:

The Get Collection use case in js-dataverse was updated to return the html in the description field, rather than markdown. This PR converts the html returned from js-dataverse into markdown for the Collection Page. (In Edit Collection Page, it will show the original html).

Which issue(s) this PR closes:

Special notes for your reviewer:

This change depends on a js-dataverse PR IQSS/dataverse-client-javascript#265. When that PR is approved, package.json should be updated to use the alpha version of the library.

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

Create a Collection and add html in the description field. The Collection Page should show the rendered html. Go to Edit Collection Page. It should show the original html that was submitted.

@ekraffmiller ekraffmiller added SPA.Q1 Not related to any specific Q1 feature Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 GREI Re-arch GREI re-architecture-related FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) labels Feb 20, 2025
@coveralls
Copy link

coveralls commented Feb 20, 2025

Coverage Status

coverage: 97.222% (+0.003%) from 97.219%
when pulling 34a5d3b on feat/599-get-collection-description-html
into 4338c7e on develop.

Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

All good! Just 2 minor comments

g-saracca
g-saracca previously approved these changes Feb 24, 2025
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

Approving, thanks!

@ofahimIQSS
Copy link
Contributor

test/e2e is failing on this - please advise :)

@ekraffmiller
Copy link
Contributor Author

@ofahimIQSS I think this is a timing issue - the csv file has be ingested and converted to a tab-delimited file, which I think happens asynchronously on the server side. (I ran it locally and can't reproduce the error.)I updated the test to check the filterBy using text files, which don't have to be ingested.
@g-saracca, can you review my change?

@github-project-automation github-project-automation bot moved this from QA ✅ to Ready for QA ⏩ in IQSS Dataverse Project Feb 24, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Feb 25, 2025
@ofahimIQSS
Copy link
Contributor

testing passed but need confirmation on why the UI review and tests are pending

@g-saracca
Copy link
Contributor

@ofahimIQSS All UI Reviews passing.

@ofahimIQSS ofahimIQSS merged commit 5a2e625 into develop Feb 26, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Feb 26, 2025
@ofahimIQSS ofahimIQSS deleted the feat/599-get-collection-description-html branch February 26, 2025 14:32
@ofahimIQSS ofahimIQSS removed their assignment Feb 26, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) GREI Re-arch GREI re-architecture-related Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q1 Not related to any specific Q1 feature

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

HTML Tags Not Preserved in Dataverse Root Collection Description Field

5 participants