[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#932957: #932957 Please migrate Release Notes to reStructuredText



Hi,

Paul Gevers <elbrus@debian.org> wrote (Thu, 24 Aug 2023 14:10:41 +0200):
> Hi Holger,
> 
> On 29-07-2023 21:29, Holger Wansing wrote:
> > I have worked out the last big blocker for this migration now.
> > That is, to allow the build on wolkenstein, which is happening via the
> > parts/7release-notes script in webmaster-team/cron git repo.
> 
> I have just requested webmaster to switch the bookworm build from the 
> master branch to the bookworm branch [1]. After that request gets merged 
> and deployed, I'd like you to publish your work in the master branch 
> such that we can work from there (and see the results too [2]). Because 
> in your worked we stopped making notes per architecture, we probably 
> need to make further changes to the webmaster archive, but let's first 
> build something.

Please note, that the webmaster-team/cron script has to be overworked,
to deal with the new reST format.
I have prepared that in 
https://salsa.debian.org/holgerw/cron/-/commits/master?ref_type=heads
(as written above).


Rationale:
It is common for all documentation packages we have on www.debian/doc,
that the package itself creates files during package build, which do not
fit into the webpage system (main point: content negotiation).
To deal with this, someone from the ddp team has developed a script
(long ago; don't know by head who was this), that renames the files 
to fit the webpage (basically this is about adding the language
extension). This is in webmaster-team/cron/parts/7doc.

With the old docbook release-notes, this has been dealed with directly
in the build script.
Now in the new reST world, I have basically copied the whole build 
mechanism from the developers-reference as is, with the intention to
rely on the mechanism from the 7doc script mentioned above
(the 7doc script has been adapted explicitly for reST/sphinx).

The release-notes have always been a corner case when it comes to how
they were built, compared to all other docs:
the r-n are built from source explicitly for the website, while for all 
the other documentation we just unpack their binary debian packages,
rename the files via 7doc and that's it.
This does not work for the r-n, because there is no Debian package existing
for them.
So the r-n are always a separate world.
Based on that, I have kept the 7doc mechanism separately too, copied into
the new 7release-notes.
Means the 7release-notes script from webmaster-team/cron git repo
gets extremely expanded, to copy (and adjust) the functionality from 7doc.

I have developed and tested this here locally, it should work fine.

So I have created a merge request to get this done for the website:
https://salsa.debian.org/webmaster-team/cron/-/merge_requests/13


Best regards
Holger

-- 
Holger Wansing <hwansing@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076


Reply to: