From Fedora Project Wiki

(Created page with 'There are a number of decisions about how the Docs team will deal with F12 that we should be thinking about. I have much to add to all of these topics, please feel free to expan...')
 
Line 25: Line 25:
=== What does release-notes.srpm look like ===
=== What does release-notes.srpm look like ===


Publican produced the rpm way differently than we used to.  For F11, we more or less followed the model of F10 with the single change that the release notes (only one of 6 docs in release-notes.rpm) were built in the srpm.  Previously, already built docs were provided.
Publican produces the rpm very differently than the way we used to.  For F11, we more or less followed the model of F10 with the single change that the release notes (only one of 6 docs in release-notes.rpm) were built in the srpm.  Previously, already built docs were provided.
 
Currently, the release notes and the supporting readmes are supplied in the RPM in all the languages (currently around 40).  These are installed on every system.  The Publican model is to have one document in one language per RPM.  It had been suggested that we could subpackage the languages, allowing only the installation of the relevant language.  While this could save considerable space, especially as the number of languages increases, it is not at all clear that current release engineering practices and tools could support this in actual practice.


[[Category:Docs_Project]]
[[Category:Docs_Project]]

Revision as of 23:09, 29 April 2009

There are a number of decisions about how the Docs team will deal with F12 that we should be thinking about.

I have much to add to all of these topics, please feel free to expand on any of these, and add additional decisions we should make.

What will release notes look like

There has been some discussion that the release notes are too long. On the one hand, more detailed release notes discourage people from reading them and are more work for translators. On the other, every change is important to somebody.

What will we use for language-loc codes

Fedora, ISO, and Publican all have different ideas about language-location codes. What will we do?

How should release notes be displayed

Currently, release notes and about fedora are displayed using yelp. The remaining documents are left for the user to discover in /usr/share/doc/HTML. What is the right answer?

Should we convert minor docs to Publican

README, README-burning-isos, README-live-images, homepage and About-Fedora are still produced using fedora-doc-utils. Should they be converted to Publican?

What is the future of homepage

It isn't entirely clear that this is even needed.

What does release-notes.srpm look like

Publican produces the rpm very differently than the way we used to. For F11, we more or less followed the model of F10 with the single change that the release notes (only one of 6 docs in release-notes.rpm) were built in the srpm. Previously, already built docs were provided.

Currently, the release notes and the supporting readmes are supplied in the RPM in all the languages (currently around 40). These are installed on every system. The Publican model is to have one document in one language per RPM. It had been suggested that we could subpackage the languages, allowing only the installation of the relevant language. While this could save considerable space, especially as the number of languages increases, it is not at all clear that current release engineering practices and tools could support this in actual practice.