D-Net
/
openaire-graph-docs
6
1
Fork 5
Code Issues 5 Pull Requests 2 Packages Projects Releases 67 Wiki Activity

Add versioning section & changelog #10

Merged
miriam.baglioni merged 7 commits from changelog into main 2022-12-30 16:35:01 +01:00
Conversation 2 Commits 7 Files Changed 1 +31 -2
1 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/changelog.md
View File

@ -2,5 +2,34 @@
sidebar_position: 12 sidebar_position: 12
--- ---
# Changelog # Versions & changelog
<span className="todo">TODO</span>
## Versioning
Our versioning policy follows the [Semantic Versioning specification](https://semver.org/).
In our case, given a version `MAJOR.MINOR.PATCH`, we increment the:
* `MAJOR` version when the data model of the Graph changes
* `MINOR` version when the pipeline (e.g., different deduplication method, different implementation for an enrichment process) or major data sources change
schatz marked this conversation as resolved Outdated
thanasis.vergoulis commented 2022-11-15 11:33:41 +01:00
Outdated
Review
Copy Link

"or the data sources change"
=>
"or major changes in data sources"

"or the data sources change" => "or major changes in data sources"
* `PATCH` version when the graph data are updated
## Changelog
This section will document all notable changes for each graph version.
thanasis.vergoulis commented 2022-11-15 11:35:29 +01:00
Review
Copy Link

This section documents notable changes between all subversions of a particular "MAJOR" version of the graph...

I do not know how to say this in a better way but you could find something I think ...

This section documents notable changes between all subversions of a particular "MAJOR" version of the graph... I do not know how to say this in a better way but you could find something I think ...
schatz commented 2022-11-17 13:27:34 +01:00
Review
Copy Link

Why only subversions of a particular "MAJOR" version ?

At each time, I think that the changelog should list the changes of all past versions.

So, in each new release, we will only append the changes of the new version at this page and not show only the changes that it introduces.

What do you think abou that @claudio.atzori ?

Why only subversions of a particular "MAJOR" version ? At each time, I think that the changelog should list the changes of all past versions. So, in each new release, we will only append the changes of the new version at this page and not show only the changes that it introduces. What do you think abou that @claudio.atzori ?
claudio.atzori commented 2022-11-17 16:06:03 +01:00
Review
Copy Link

This website is meant to document the public dump, which is currently published every six months. Hence the documentation website updates should go along with it, therefore it's changelog will grow release after release, i.e. dump after dump.

I would prefer to keep the history, appending new entries on each release, so that the readers will always have a glimpse of the evolution.

The level of detail to describe is going to be the tricky part here. I try to systethise these aspects in the ticket belonging to each content update round (see #8233 for example), but I feel like we could do better.

This website is meant to document the public dump, which is currently published every six months. Hence the documentation website updates should go along with it, therefore it's changelog will grow release after release, i.e. dump after dump. I would prefer to keep the history, appending new entries on each release, so that the readers will always have a glimpse of the evolution. The level of detail to describe is going to be the tricky part here. I try to systethise these aspects in the ticket belonging to each content update round (see [#8233](https://support.openaire.eu/issues/8233) for example), but I feel like we could do better.
### v5.0.0
#### Added
- [Impact indicators](/data-model/entities/result#indicators) at the level of the Result
- [Beginner's kit](/downloads/beginners-kit) in the Downloads section
- New relation types. See the [complete set of relationship](/data-model/relationships#relationship-types)
schatz commented 2022-12-30 15:54:28 +01:00
Outdated
Review
Copy Link

@miriam.baglioni not sure if we want to list all new relationships here in the changelog.
Not sure either if I have included all new (and correct) relations, things may have changed since I wrote this.

@miriam.baglioni not sure if we want to list all new relationships here in the changelog. Not sure either if I have included all new (and correct) relations, things may have changed since I wrote this.
-
#### Changed
- FOS and SDGs were removed from the [result subjects](/data-model/entities/result#subjects)
- Measures were removed from the [result instance](/data-model/entities/result#instance)