Re: DPV versioned namespaces for v1 and v2

Hi All.
Following our previous discussions on this topic, we had agreed that we 
will attempt to implement versioned IRIs as they are good practice. To 
implement this, I have:

1) changed the folder structure to have v1.0 and v2.0 for each release - 
see https://github.com/w3c/dpv/tree/dev/v2.0, and
2) changed the IRIs from w3id.org/dpv to w3id.org/dpv/v<N.0>.

These changes are currently in the dev branch, and a live version is 
available on dev.dpvcg.org e.g. https://dev.dpvcg.org/v1.0/dpv/ and 
https://dev.dpvcg.org/v2.0/dpv/

These changes need to be reviewed before we go ahead with the release. 
**Please help with this** to ensure we catch as many of the major issues 
as we can before publishing it.

The associated issue with this is:  Preserving older versions of DPV and 
other resources #45 https://github.com/w3c/dpv/issues/45

Links to v2.0 in the dev branch:

https://dev.dpvcg.org/v2.0/dpv/index.html
https://dev.dpvcg.org/v2.0/pd/index.html
https://dev.dpvcg.org/v2.0/tech/index.html
https://dev.dpvcg.org/v2.0/risk/index.html
https://dev.dpvcg.org/v2.0/ai/index.html
https://dev.dpvcg.org/v2.0/justifications/index.html
https://dev.dpvcg.org/v2.0/loc/index.html
https://dev.dpvcg.org/v2.0/legal/index.html
https://dev.dpvcg.org/v2.0/legal/eu/index.html
https://dev.dpvcg.org/v2.0/legal/eu/gdpr/index.html
https://dev.dpvcg.org/v2.0/legal/eu/dga/index.html
https://dev.dpvcg.org/v2.0/legal/eu/aiact/index.html
https://dev.dpvcg.org/v2.0/legal/eu/nis2/index.html
https://dev.dpvcg.org/v2.0/legal/eu/rights/index.html
https://dev.dpvcg.org/v2.0/legal/de/index.html
https://dev.dpvcg.org/v2.0/legal/gb/index.html
https://dev.dpvcg.org/v2.0/legal/ie/index.html
https://dev.dpvcg.org/v2.0/legal/in/index.html
https://dev.dpvcg.org/v2.0/legal/us/index.html

Note that the primer, guides, and examples are still in the root folder 
and are not under v2.0 folder. The links in the document all have the 
form w3id.org/dpv/v2.0 - which will give a 404 as that path doesn't 
exist (in the master branch). For dealing with this, I manually replace 
the path, or use a hosts file or a browser extension which can redirect 
w3id.org/dpv to dev.dpvcg.org.

The w3id config also needs to be updated to reflect the new structure.

Regards,
Harsh

On 07/06/2024 16:16, Harshvardhan J. Pandit wrote:
> Hi.
> In the last meeting, there was a discussion (thanks to Julian) about 
> having versioned namespaces to distinguish between DPV v1 and v2. I 
> agree with this as it is also a 'best practice' for publishing on the 
> internet. The implementation requires agreeing on how we will implement 
> this as this decision cannot be trivially 'undone' in the future. *If we 
> can reach such an agreement in the next ~2 weeks, we can publish DPV v2 
> with this versioned IRI*. Otherwise, I think we should go ahead with and 
> v2 release and then later provide this as I want us to drive up the 
> adoption of DPV with key stakeholders and the v2 release will help do that.
> 
> To keep track of discussions, I had already created an issue which we 
> will reuse here: https://github.com/w3c/dpv/issues/45
> 
> # What is versioned IRIs / namespaces?
> 
> The URL for using DPV is https://w3id.org/dpv - which doesn't indicate 
> which version of DPV is being used. By default, it will always point to 
> the latest version i.e. what is published on github. To allow adopters 
> to continue to use specific versions, e.g. v2 when there is a v3, we 
> want to create separate IRIs/URLs.
> 
> # What will IRIs look like?
> 
> We continue using w3id (strongly recommended) and have:
> 
> w3id.org/dpv - always the latest version
> w3id.org/dpv/legal/eu/gdpr - latest version of gdpr
> w3id.org/dpv/v1 - v1
> w3id.org/dpv/v2 - v2
> w3id.org/dpv/v2.1 - v2.1
> w3id.org/dpv/v2/tech - v2 tech
> w3id.org/dpv/v1/legal/eu/gdpr - v1 gdpr
> 
> # How will the repo be structured?
> 
> Currently, we have all our stuff directly in the root folder - 
> https://github.com/w3c/dpv To have versions, we follow the structure 
> similar to what the DCAT-AP repo uses: 
> https://github.com/SEMICeu/DCAT-AP/tree/master/releases
> 
> So our DPV repo will look like:
> 
> root
>   |-- v1
>   |-- v2
>     |-- dpv
>     |-- pd
>     |-- legal etc.
>   |-- primer
>   |-- guides
>   |-- examples
> 
> # What will be versioned?
> 
> Definitely the vocabulary i.e. HTML and RDF files will be maintained for 
> each version. Guides and other documents will be not be versioned - they 
> will remain where they are.
> 
> I see no value in maintaining separate copies of the Primer and other 
> guides - as part of the publication process an archived copy is 
> available via the w3c publishing process e.g. 
> https://www.w3.org/community/reports/dpvcg/CG-FINAL-primer-20221205/ is 
> the Primer from 2022.
> 
> # How will this be maintained?
> 
> The size of each DPV release is approx. 100-150MB counting everything in 
> it. Without all the media and other things, this can be reduced. So we 
> should be okay to continue hosting this on Github for a while (>10 
> releases).
> 
> Another important question is whether we do any minor releases e.g. 
> v2.0.1 e.g. to fix typos or add in a few concepts. I am not in favour of 
> this as it is an added burden to create a release without a lot of 
> value. So far now, I am only thinking we have major releases i.e. v2, 
> v2.1, and so on. And these will be versioned. If its an emergency or 
> urgency to create a small change, then we will do minor releases e.g. 
> v2.0.1 with a crucial fix.
> 
> ---
> 
> Please let us know your thoughts by replying to this email or 
> commenting/using emojis on the issue https://github.com/w3c/dpv/issues/45

-- 
---
Harshvardhan J. Pandit, Ph.D
Assistant Professor
ADAPT Centre, Dublin City University
https://harshp.com/

Received on Monday, 17 June 2024 12:08:01 UTC