May I, as a seasoned professional IT architect, implementer, group leader, manager and consultant correct or disagree with a point raised in the minutes below
The release notes are a planning document, not a document that is first used after the installation. That is my disagreement with the statement made today.
We plan the upgrades based on the release notes, we test new software, and we review the changes.
If we have the hardware and cpu resourses, and diskspace changes, we plan a migration to the new release. This takes place much before a new release installation is
attempted.
Changes that we had to adjust to in the past were with virtual memory consumption, database changes, and systemd. No! Release notes are a must that must be provided at least a month or two before the actual release.
And the best and easiest way is to produce the notes in pdf format, and provide a download link. Many users highlight parts of release notes if they are in pdf format, and distribute the highlighted document to their staff.
Release notes before. I also want to suggest that the pdf file be put into the download directories. The mirror sites should have a link to a single RH repository.
A distribution document that accompanies the new release serves to point out what in the release notes is late, deferred, or partially implemented. This latter document I call the excuse document.
Leslie Satenstein
On Fri, 05 Sep 2014 15:12:04 -0400Matthias Clasen <mclasen@xxxxxxxxxx> wrote:> On Fri, 2014-09-05 at 16:52 +0200, Petr Kovar wrote:> \> > It could be gnome-documents as Matthias proposed if we choose to ship PDF> > instead of a bunch of HTML pages.> > > > It could be yelp as it supports transforming DocBook/Mallard XML as well as> > viewing HTML pages. I just tested it and yelp works quite well:> > > > $ yelp /usr/share/doc/fedora-release-notes/index.html> > I think all of these
questions about formats and tools are a bit> secondary though.I agree that these are secondary as long as desktop users can find what theyare looking for. Providing a docs search functionality would surely helpwith that need.> Having the release notes on the system really makes most sense if we> actually make an effort to present them to the user when he would be> most interested in seeing them - right after installation.+1 > The current post-install workflow already launches yelp with the>
gnome-getting-started guide. Maybe that page can be expanded to include> the release notes in some form ?Yes, this is something we can do. Assuming that we want to provide alink to the Release Notes from the GNOME Getting Started landing page,there are multiple ways to approach this. As I said, we could add thelink upstream and use Mallard conditionals to only display the link onFedora since the link is downstream-specific. We could also provide adownstream patch but translations would be a problem then.GNOME Initial Setup could also get an extra button that would launch theRelease Notes.Cheers,pk-- 