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.

Sign up for GitHub

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

Jump to bottom

make Croissant support official, update exporter docs #10533

Merged
merged 18 commits into from
Jul 31, 2024
Merged

make Croissant support official, update exporter docs #10533

merged 18 commits into from
Jul 31, 2024

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Apr 26, 2024 •
edited
Loading

What this PR does / why we need it:

We have released to Maven Central an external metadata exporter from this new dedicated repo: https://github.com/gdcc/exporter-croissant

This pull request improves the guides to talk about Croissant and better explain all about external exporters. An inventory has been added.

This PR also adds docs about the behavior of the <head> tag that we changed with this pull request:

Which issue(s) this PR closes:

Special notes for your reviewer:

A related PR to mention the new exporter:

Suggestions on how to test this:

Test the Croissant jar.

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

Yes, when enabled, Croissant will appear in the dropdown of exports:

Screenshot-2024-03-14-at-11 51 42-AM

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

Included.

Additional documentation:

This PR is mostly docs. Some decent entry points:

@pdurbin pdurbin changed the title add docs for Croissant, tweak exporter docs #10341 add docs for Croissant, tweak exporter docs Apr 26, 2024
@pdurbin pdurbin mentioned this pull request May 7, 2024
Open
@pdurbin pdurbin mentioned this pull request May 28, 2024
Closed
@pdurbin pdurbin marked this pull request as ready for review May 28, 2024 16:15
@pdurbin pdurbin mentioned this pull request May 28, 2024
Closed
@coveralls
Copy link

coveralls commented May 28, 2024 •
edited
Loading

Coverage Status

coverage: 20.627%. remained the same
when pulling b5e7401 on 10341-croissant
into a466c97 on develop.

@pdurbin
Copy link
Member Author

pdurbin commented Jun 4, 2024

Yesterday at standup I mentioned some tweaks I was working on for the Croissant exporter and I did put out a release, 0.1.2:

https://github.com/gdcc/exporter-croissant/blob/croissant-0.1.2/CHANGELOG.md#012

@pdurbin
Copy link
Member Author

pdurbin commented Jun 11, 2024

At tech hours today I gave a preview of the talk I'm giving tomorrow for the Croissant Task Force. You can find my slides linked from this invitation to the community to join: https://groups.google.com/g/dataverse-community/c/JI8HPgGarr8/m/ONqgdyKJAAAJ

@pdurbin pdurbin mentioned this pull request Jun 13, 2024
Open
qqmyers
qqmyers approved these changes Jun 18, 2024
View reviewed changes
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 good. I fixed some bad grammar that was in the text before the PR.

@qqmyers qqmyers mentioned this pull request Jun 21, 2024
Merged
@pdurbin pdurbin self-assigned this Jul 9, 2024
@pdurbin
Copy link
Member Author

pdurbin commented Jul 9, 2024 •
edited
Loading

At standup today I mentioned I wanted to tweak this PR to remove the inventory of exporters from Sphinx now that we are keeping the list at https://github.com/gdcc/dataverse-exporters . I'm linking there instead now. See b5e7401.

To be clear, I'm leaving the heading for the inventory in the guides because I reference it from so many pages...

vim source/api/native-api.rst +1194
vim source/developers/metadataexport.rst +15
vim source/installation/config.rst +3193
vim source/user/dataset-management.rst +39

... but now the inventory simply links to the README in the other repo.

I'm happy to answer any questions about this PR (just docs) and the code itself, which is at https://github.com/gdcc/exporter-croissant

@pdurbin pdurbin removed their assignment Jul 9, 2024
@cmbz cmbz added the Size: 0.5 A percentage of a sprint. 0.35 hours label Jul 10, 2024
@pdurbin pdurbin added the FY24 Sprint 23 FY24 Sprint 23 label Jul 17, 2024
@scolapasta scolapasta self-assigned this Jul 18, 2024
@pdurbin pdurbin changed the title add docs for Croissant, tweak exporter docs make Croissant support official, update exporter docs Jul 19, 2024
@pdurbin pdurbin mentioned this pull request Jul 19, 2024
Closed
@scolapasta scolapasta merged commit 28665c8 into develop Jul 31, 2024
15 of 16 checks passed
@pdurbin pdurbin added this to the 6.4 milestone Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qqmyers qqmyers qqmyers approved these changes

Assignees

@scolapasta scolapasta

Labels
FY24 Sprint 23 FY24 Sprint 23 Size: 0.5 A percentage of a sprint. 0.35 hours
Projects
None yet
Milestone
6.4
Development

Successfully merging this pull request may close these issues.

Croissant support 🥐
5 participants
@pdurbin @coveralls @qqmyers @scolapasta @cmbz