Skip to content

explain how to customize root collection in "running in Docker" tutorial - #11201

Merged
ofahimIQSS merged 3 commits into
developfrom
10541-root-alias-name2
Feb 18, 2025
Merged

explain how to customize root collection in "running in Docker" tutorial#11201
ofahimIQSS merged 3 commits into
developfrom
10541-root-alias-name2

Conversation

@pdurbin

@pdurbin pdurbin commented Jan 30, 2025

Copy link
Copy Markdown
Member

What this PR does / why we need it:

In Milestone F of the container proposal and in recent discussions, we've said we want people to be able to configure the alias and name of the root collection.

Which issue(s) this PR closes:

Special notes for your reviewer:

This PR is an alternative to #11196. It allows more customization.

Please feel free to discuss here or at https://dataverse.zulipchat.com/#narrow/channel/375812-containers/topic/in.20demo.2Feval.20env.2C.20configure.20root.20collection.20alias.20and.20name/near/496383414

Suggestions on how to test this:

Follow the provided instructions. Your root collection should look like this:

Screenshot 2025-01-30 at 3 57 53 PM

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

No.

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

Yes, included.

Additional documentation:

https://dataverse-guide--11201.org.readthedocs.build/en/11201/container/running/demo.html#root-collection-customization-alias-name-etc

@pdurbin pdurbin added Component: Containers Anything related to cloudy Dataverse, shipped in containers. Size: 3 A percentage of a sprint. 2.1 hours. labels Jan 30, 2025
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@pdurbin pdurbin added the FY25 Sprint 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) label Jan 31, 2025

API_TOKEN=$(grep apiToken "/tmp/setup-all.sh.out" | jq ".data.apiToken" | tr -d \")
export API_TOKEN

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Add "if file exists" here, perhaps.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@Kris-LIBIS I added the "if" in this commit: 4f8ea65

Please take a look! Thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great.

@pdurbin pdurbin self-assigned this Feb 12, 2025
@pdurbin pdurbin removed their assignment Feb 12, 2025
@github-actions

Copy link
Copy Markdown

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:10541-root-alias-name2
ghcr.io/gdcc/configbaker:10541-root-alias-name2

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@cmbz cmbz added the FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) label Feb 12, 2025

@qqmyers qqmyers left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Haven't tested. Looks fine.

@ofahimIQSS ofahimIQSS self-assigned this Feb 18, 2025
@ofahimIQSS

Copy link
Copy Markdown
Contributor

This one is good to go, test and regression tested, no issues found

@ofahimIQSS
ofahimIQSS merged commit 0f42773 into develop Feb 18, 2025
@ofahimIQSS
ofahimIQSS deleted the 10541-root-alias-name2 branch February 18, 2025 20:19
@ofahimIQSS ofahimIQSS removed their assignment Feb 18, 2025
@pdurbin pdurbin added this to the 6.6 milestone Feb 24, 2025
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 16 FY25 Sprint 16 (2025-01-29 - 2025-02-12) FY25 Sprint 17 FY25 Sprint 17 (2025-02-12 - 2025-02-26) Size: 3 A percentage of a sprint. 2.1 hours.

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

In containers, document how to change the root collection alias and name (milestone F)

5 participants