NCEAS / metacat

Data repository software that helps researchers preserve, share, and discover data

https://knb.ecoinformatics.org/software/metacat

GNU General Public License v2.0

26 stars 12 forks source link

Release Notes and Metacat Legacy Deployments Outreach #1671

Closed artntek closed 5 months ago

artntek commented 1 year ago

Metacat 3.0.0 will introduce some breaking changes. This issue is intended to keep track of any communications/outreach we need to do, to help organizations navigate the upgrade, if they have much older versions of Metacat installed

artntek commented 1 year ago

Skins-based Metacat deployments

This is a list of known organizations that still have skins-based deployments of Metacat.

We can reach out about their upgrade path in light of our upcoming breaking changes for Metacat v3.0.0

mbjones commented 1 year ago

Morpho no longer supported

In 3.0.0, we no longer support the original Metacat API, and therefore all Morpho clients (and other clients that depend on the old API) will no longer work. Client access can be done via the DataONE API.

For reference, we did work on a version of Morpho (milestone 2.0.0) that works against the DataONE API, but it never got released due to some blockers and lack of resources to complete it. It was very close though.

artntek commented 7 months ago

With the 3.0.0 release, we want to issue a DOI, and make sure our release notes have a good description of what to look out for when upgrading, and the features that have been removed

artntek commented 7 months ago

Consider separating release notes from README

artntek commented 7 months ago

Release notes should stipulate that you must be at metacat v2.19.0 (or whatever the last release in the 2.x series) before trying to upgrade to 3.0.0

doulikecookiedough commented 6 months ago

Additional Context RE: Skins-based Deployments

Since the old/original Metacat API is being deprecated, and skins-based deployments use the old Metacat API calls, it will not work at all with Metacat 3.0.0
While ESS-DIVE has their own custom skin, it is a special case - it does not use the old Metacat API at all so they should be fine. Matthew has tested and confirmed their deployment with 3.0.0 and it appears to be ok.
The code for displaying skins is still there (recognizing the qformat parameter and returning the XSLT-styled MXL), but the skins themselves use old metacat api calls that are no longer supported

mbjones commented 6 months ago

to add to this, ESS-DIVE doesn't even use the skin for a UI per se -- instead, they are using it to trigger an XSLT transform, just as we are doing in the "metacatui" skin. Neither of those cases use the skins structure for a UI directly but indirectly it is used to configure XSLT.

doulikecookiedough commented 5 months ago

The first draft for the 3.0.0 release notes have been added to branch feature-1671-release-docs in the RELEASE-NOTES.md document.

Upgrade notes, breaking change notes and feedback for this draft will be discussed during the next backend meeting.

doulikecookiedough commented 5 months ago

I have added upgrade notes to RELEASE-NOTES.md based on Jing's upgrade notes document, and updated README.md with ORCIDs for the current contributors and NCEAS & DataONE banners at the bottom.

[x] Add ORCID identifiers for the 4 current authors
[x] add the NCEAS and DataONE banner images to the README (decide on bottom or top)

To Do:

[ ] Add a DOI and citation to the README at the top
- See https://github.com/NCEAS/metacat/issues/1480

doulikecookiedough commented 5 months ago

This issue has been (almost) completed via Feature-1671: 3.0.0 Release Notes #1833. The last item being the citation which will be tracked via Add a citation for this repo