Skip to content

Commit

Permalink
Updated Release header text (#1124)
Browse files Browse the repository at this point in the history
* Updated Release header text

* Serialized

* Manually updated README.md for now
  • Loading branch information
steveraysteveray authored Feb 13, 2025
1 parent 7d1c34f commit 976f094
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ QUDT - ***Q***uantities, ***U***nits, ***D***imensions and Data***T***ypes

There are three ways to bring the QUDT ontology into your environment.
1. Download the latest GitHub Release [here](https://github.com/qudt/qudt-public-repo/releases).
2. Use the resolved graph and instance URIs available [here](https://www.qudt.org/2.1/catalog/qudt-catalog.html).
2. Use the resolved graph and instance URIs available [here](https://www.qudt.org/3.0.0/catalog/qudt-catalog.html).
3. Use GitHub fork to get the sources and build them using the instructions [here](https://github.com/qudt/qudt-public-repo/wiki/Installing-QUDT-for-Contributors).

Overview
Expand Down Expand Up @@ -43,18 +43,18 @@ The QUDT ontology is provided in two forms: OWL and SHACL. By default, the vocab

```
Change this line:
owl:imports <http://qudt.org/2.1/schema/shacl/qudt> ;
owl:imports <http://qudt.org/3.0.0/schema/shacl/qudt> ;
To:
owl:imports <http://qudt.org/2.1/schema/qudt> ;
owl:imports <http://qudt.org/3.0.0/schema/qudt> ;
```

If you are using the tools from TopQuadrant, you should also change the comment line at the top of the same file:

```
Change this line:
# imports: http://qudt.org/2.1/schema/shacl/qudt
# imports: http://qudt.org/3.0.0/schema/shacl/qudt
To:
# imports: http://qudt.org/2.1/schema/qudt
# imports: http://qudt.org/3.0.0/schema/qudt
```

Configuration for QUDT Users versus QUDT Developers
Expand All @@ -64,18 +64,18 @@ QUDT SHACL is supported by a set of validation rules that check the integrity an

```
Change this line:
owl:imports <http://qudt.org/2.1/collection/qa/all> ;
owl:imports <http://qudt.org/3.0.0/collection/qa/all> ;
To:
owl:imports <http://qudt.org/2.1/collection/usertest> ;
owl:imports <http://qudt.org/3.0.0/collection/usertest> ;
```

If you are using the tools from TopQuadrant, you should also change the comment line at the top of the same file:

```
Change this line:
# imports: http://qudt.org/2.1/collection/qa/all
# imports: http://qudt.org/3.0.0/collection/qa/all
To:
# imports: http://qudt.org/2.1/collection/usertest
# imports: http://qudt.org/3.0.0/collection/usertest
```

Currently, the tests in the usertest graph check for references to deprecated instances or properties and recommend the updated instance or property.
Expand All @@ -85,9 +85,9 @@ Protege Users

The QUDT ontologies have been tested to load without error in Protege 5.6.4.

To load QUDT into Protege, choose "Open from URI" from the file menu, and enter http://qudt.org/2.1/vocab/unit
To load QUDT into Protege, choose "Open from URI" from the file menu, and enter http://qudt.org/3.0.0/vocab/unit

(The "facade" file that is resolvable on the web (http://qudt.org/2.1/schema/facade/qudt) is already configured to load the OWL schema rather than the SHACL schema, so Protege users will be in the OWL world using this method.)
(The "facade" file that is resolvable on the web (http://qudt.org/3.0.0/schema/facade/qudt) is already configured to load the OWL schema rather than the SHACL schema, so Protege users will be in the OWL world using this method.)

Ontology libraries
------------------
Expand Down
8 changes: 6 additions & 2 deletions src/build/release/release-body-header.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
As mentioned in Release 2.1.47, we are coming out with version 3.0.0 with this Release. This could be a breaking change for your applications, since some of you may be using the versioned graph URIs that include "2.1". Moving forward, those will include "3.0.x", but of course the un-versioned graphs will always resolve to the latest version. So, for example, if you use the owl:imports mechanism, your application could import http://qudt.org/2.1/vocab/unit if you want to stay with 2.1, http://qudt.org/3.0/vocab/unit if you want to explicitly migrate to the new Release, or http://qudt.org/vocab/unit if you want to always get the latest Release.
## Please note!

In Release 3.0, we are removing all the deprecated entities that have accumulated to date. They all contain the triple:
As mentioned in Release 2.1.47, we are coming out with version 3.0.0 with this Release. This could be a breaking change for your applications, since some of you may be using the versioned graph URIs that include "2.1". Moving forward, those will include "3.0.x", but of course the un-versioned graphs will always resolve to the latest version. So, for example, if you use the owl:imports mechanism, your application could import http://qudt.org/2.1/vocab/unit if you want to stay with 2.1, http://qudt.org/3.0.0/vocab/unit if you want to explicitly migrate to the new Release, or http://qudt.org/vocab/unit if you want to always get the latest Release.

In Release 3.0.0, we have removed all the deprecated entities that have accumulated to date. In the 2.1 releases, they all contained the triple:

\<entity\> qudt:deprecated true

If you have been using SHACL, you should have already been receiving notifications during validation if you were using properties or instances that were marked as deprecated, so you had an opportunity to migrate to the replacement concepts. With this new Release, those entities no longer exist.

0 comments on commit 976f094

Please sign in to comment.