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

switch container demo tutorial from FAKE to perma #11108

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Dec 18, 2024

What this PR does / why we need it:

The Permalink PID provider is well suited to dev, devo, and evaluation environments. Partially inspired by a question about how to set it up, we decided to go ahead and update the compose.yml file used in our demo/eval tutorial (6.5 version) to use Permalinks instead of the FAKE DOI provider.

Which issue(s) this PR closes:

Special notes for your reviewer:

As I mentioned in Slack, I still think the docs are a bit off but I didn't want to muddy the waters too much in this PR.

Suggestions on how to test this:

Follow the tutorial. Make sure a dataset is properly indexed.

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

No, but as shown in the screenshot below, PIDs look something like this: perma:DV/ADTGQL

In the citation, the URL form is shown, like this: http://localhost:8080/citation?persistentId=perma:DV/ADTGQL

Screenshot 2024-12-18 at 3 17 35 PM

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

Yes, added.

Additional documentation:

Preview at https://dataverse-guide--11108.org.readthedocs.build/en/11108/container/running/demo.html

@pdurbin pdurbin added Size: 3 A percentage of a sprint. 2.1 hours. FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) Component: Containers Anything related to cloudy Dataverse, shipped in containers. labels Dec 18, 2024
@sekmiller sekmiller self-assigned this Dec 19, 2024
@sekmiller
Copy link
Contributor

Looks reasonable to me. Will request a look from Jim

@sekmiller sekmiller requested a review from qqmyers December 19, 2024 19:03
@sekmiller sekmiller removed their assignment Dec 19, 2024
Copy link
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

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

Looks fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Containers Anything related to cloudy Dataverse, shipped in containers. FY25 Sprint 12 FY25 Sprint 12 (2024-12-04 - 2024-12-18) Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: Ready for QA ⏩
Development

Successfully merging this pull request may close these issues.

FAKE to Permalink phase 1: container demo
3 participants