Rare project developers

[Alexander Gall <>]

On Thu, 21 Apr 2022 16:47:22 +0200, Frédéric LOUI <> 
said:

>> . Maybe that makes more sense anyway?
> Sure ! 

Or maybe it doesn't :) My original plan was to create the Release
Notes file for the next upcoming release immediately after the last
release and update it as we add commits to the master branch. This
way, there won't be much to add when the next release happens
(provided we have the discipline to do this :)

This also makes it easy to create the release notes on the docs site
automatically by converting from markdown to HTML. The notes for
proper releases can be tied to the release tags
"release-<release-number>" and if we do manage to amend the notes as
we push commits, we'd automatically have a "rolling" release note that
tracks ongoing work.

So I go back to my original propsal to maintine the notes in the Git
repo.

@csaba: I'm afraid that most of the burden will be on you since
freerouter is the most important component that also has the most
changes and there is really nobody else I see doing it. Ideally, I
would like to have a brief description of major features and bug fixes
that are comprehensible to our users. I know you won't like it but I
think that this cannot be fully automated :( I will try to do the same
for anything that has to do with packaging and release management.

-- 
Alex

> I’m opened to any suggestion that would facilitate your (also everyone's) 
> work and that obviously would make sense to everyone.

> I declared you as admin on:
> - https://github.com/rare-freertr/RARE-web. ( <----- mkdocs sources )
> - https://github.com/rare-freertr/docs.freertr.org ( <----- serialised HTML 
> files, médocs output)

> Please let me know if this is fine for you.

> If you are not familiar to mkdocs workflows we can have a quick sync VC.

> One thing I’ve in my wish list is to create a docs based of git or release 
> tag. 
> (Part of the doc can be generated automatically after a specific commit …)
> If anyone know how to do that please get back to me.

> For example in this link: you see the docs is related to a specific 
> release: 
> https://projectcalico.docs.tigera.io/about/about-calico
> Version is 3.22 with tag "latest" and nightly is "main"

> But maybe we can leave it for near future. Meanwhile we can create on the 
> left a section called: « Release »

> Please let me know your thoughts,

> All the best,
> Frederic

>> Le 21 avr. 2022 à 16:32, Alexander Gall <> a écrit :
>> 
>> Hi Fréderic
>> 
>> I'd like to create a Release Notes file in the RARE-NIX repo for each
>> release. I did this for the test releases, see
>> https://bitbucket.software.geant.org/projects/RARE/repos/rare-nix/browse/release-notes
>> how this could look like.
>> 
>> For the first release, I'm planning to simply put a reference to
>> http://docs.freertr.org/, but in future releases I'd like to include
>> what one would expect from the release notes, i.e. new features, bug
>> fixes, etc.
>> 
>> Instead of adding it to the repo, we could also add the Release Notes
>> to http://docs.freertr.org/. Maybe that makes more sense anyway?
>> 
>> -- 
>> Alex