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
schatz commented 2022-11-11 18:17:33 +01:00
Member
Copy Link

Adds versioning scheme and changelog

Adds versioning scheme and changelog
schatz added 1 commit 2022-11-11 18:17:34 +01:00
schatz requested review from claudio.atzori 2022-11-11 18:17:57 +01:00
schatz requested review from thanasis.vergoulis 2022-11-11 18:17:57 +01:00
schatz commented 2022-11-11 18:18:54 +01:00
Author
Member
Copy Link

@claudio.atzori and @thanasis.vergoulis please revise the "Versioning" section.

Also, a template for the changelog is added, but I think that would be the last part to add in the documentation website before release.

@claudio.atzori and @thanasis.vergoulis please revise the "Versioning" section. Also, a template for the changelog is added, but I think that would be the last part to add in the documentation website before release.
thanasis.vergoulis requested changes 2022-11-15 11:35:39 +01:00
docs/changelog.md Outdated
@ -5,0 +11,4 @@
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 the data sources change
thanasis.vergoulis commented 2022-11-15 11:33:41 +01:00
Collaborator
Copy Link

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

"or the data sources change" => "or major changes in data sources"
schatz marked this conversation as resolved
docs/changelog.md
@ -5,2 +18,3 @@
<span className="todo">TODO</span>
This section will document all notable changes for each graph version.
thanasis.vergoulis commented 2022-11-15 11:35:29 +01:00
Collaborator
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
Author
Member
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
Owner
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.
schatz added 1 commit 2022-11-17 13:28:20 +01:00
schatz changed title from WIP: Add versioning section to Add versioning section 2022-11-17 13:28:37 +01:00
schatz requested review from thanasis.vergoulis 2022-11-17 13:28:45 +01:00
schatz changed title from Add versioning section to Add versioning section & changelog 2022-11-17 13:36:16 +01:00
schatz requested review from miriam.baglioni 2022-12-21 13:12:36 +01:00
schatz commented 2022-12-23 12:34:58 +01:00
Author
Member
Copy Link

@claudio.atzori @miriam.baglioni Can you check the content of this?
Do we already know which are the changes to be introduced in the next update?
Do you feel that we need to add something to the proposed changelog?

@claudio.atzori @miriam.baglioni Can you check the content of this? Do we already know which are the changes to be introduced in the next update? Do you feel that we need to add something to the proposed changelog?
miriam.baglioni added 2 commits 2022-12-27 14:54:47 +01:00
schatz added 2 commits 2022-12-30 15:50:50 +01:00
schatz reviewed 2022-12-30 15:54:28 +01:00
docs/changelog.md Outdated
@ -7,0 +26,4 @@
- [Impact indicators](/data-model/entities/result#indicators) at the level of the Result
- [Beginner's kit](/downloads/beginners-kit) in the Downloads section
- New [relationship types](/data-model/relationships#relationship-types): `Reviews, IsReviewedBy, IsParentOf, IsChildOf, References, IsReferencedBy, IsNewVersionOf, IsPreviousVersionOf, HasVersion, IsVersionOf, Cites, IsCitedBy, IsVariantFormOf, IsOriginalFormOf, Obsoletes, IsObsoletedBy, IsContinuedBy, Continues, Documents, IsDocumentedBy, IsCompiledBy, Compiles, IsPartOf, HasPart, IsSourceOf, IsDerivedFrom, IsIdenticalTo`
schatz commented 2022-12-30 15:54:28 +01:00
Author
Member
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.
miriam.baglioni added 1 commit 2022-12-30 16:34:17 +01:00
miriam.baglioni merged commit e5574b8490 into main 2022-12-30 16:35:01 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
claudio.atzori
thanasis.vergoulis
miriam.baglioni
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: D-Net/openaire-graph-docs#10
No description provided.
Delete Branch "changelog"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?