doc/en_US.ISO8859-1/articles/freebsd-releng/releng-website.xml
Glen Barber 5e2b9f3d80 Document where the HTML pages for a release, such as hardware.html,
relnotes.html, readme.html, etc., are created.

Sponsored by:	The FreeBSD Foundation
2017-09-14 15:44:35 +00:00

149 lines
4.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!--
The FreeBSD Documentation Project
$FreeBSD$
-->
<sect1 xml:id="releng-website">
<title>Website Changes During the Release Cycle</title>
<para>This section describes the changes to the website that should
occur as the release cycle progresses.</para>
<note>
<para>The files specified throughout this section are relative to
the <literal>head/</literal> branch of the
<literal>doc</literal> repository in
<application>Subversion</application>.</para>
</note>
<sect2 xml:id="releng-website-prerelease">
<title>Website Changes Before the Release Cycle Begins</title>
<para>When the release cycle schedule is available, these files
need to be updated to enable various different functionalities
on the &os;&nbsp;Project website:</para>
<informaltable frame="none" pgwide="0">
<tgroup cols="2">
<thead>
<row>
<entry>File to Edit</entry>
<entry>What to Change</entry>
</row>
</thead>
<tbody>
<row>
<entry><filename>share/xml/release.ent</filename></entry>
<entry>Change <literal>beta.upcoming</literal>
from <literal>IGNORE</literal> to
<literal>INCLUDE</literal></entry>
</row>
<row>
<entry><filename>share/xml/release.ent</filename></entry>
<entry>Change <literal>%&nbsp;beta.upcoming</literal>
from <literal>IGNORE</literal> to
<literal>INCLUDE</literal></entry>
</row>
<row>
<entry><filename>share/xml/release.ent</filename></entry>
<entry>Change <literal>beta.testing</literal>
from <literal>IGNORE</literal> to
<literal>INCLUDE</literal></entry>
</row>
<row>
<entry><filename>share/xml/release.ent</filename></entry>
<entry>Change <literal>%&nbsp;beta.testing</literal>
from <literal>IGNORE</literal> to
<literal>INCLUDE</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 xml:id="releng-website-beta-rc">
<title>Website Changes During <literal>BETA</literal> or
<literal>RC</literal></title>
<para>When transitioning from <literal>PRERELEASE</literal> to
<literal>BETA</literal>, these files need to be updated to
enable the &quot;Help Test&quot; block on the download page.
All files are relative to <filename
class="directory">head/</filename> in the
<literal>doc</literal> repository:</para>
<informaltable frame="none" pgwide="0">
<tgroup cols="2">
<thead>
<row>
<entry>File to Edit</entry>
<entry>What to Change</entry>
</row>
</thead>
<tbody>
<row>
<entry><filename>en_US.ISO8859-1/htdocs/releases/11.0R/schedule.xml</filename></entry>
<entry>Change <literal>%&nbsp;beta.local.where</literal>
<literal>IGNORE</literal> to
<literal>INCLUDE</literal></entry>
</row>
<row>
<entry><filename>share/xml/release.ent</filename></entry>
<entry>Update <literal>%&nbsp;betarel.vers</literal> to
<literal>BETA<replaceable>1</replaceable></literal></entry>
</row>
<row>
<entry><filename>share/xml/news.xml</filename></entry>
<entry>Add an entry announcing the
<literal>BETA</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Once the &branch.relengx; branch is created, the various
release-related documents need to be generated and manually
added to the <literal>doc/</literal> repository.</para>
<para>Within <filename class="directory">release/doc</filename>,
invoke &man.make.1; to generate
<filename>errata.html</filename>,
<filename>hardware.html</filename>,
<filename>readme.html</filename>, and
<filename>relnotes.html</filename> pages, which are then added
to <filename
class="directory">doc/head/en_US.ISO8859-1/htdocs/releases/<replaceable>X.Y</replaceable>R/</filename>,
where <replaceable>X.Y</replaceable> represents the major and
minor version number of the release.</para>
<para>The <literal>fbsd:nokeywords</literal> must be set to
<literal>on</literal> on the newly-added files before the
pre-commit hooks will allow them to be added to the
repository.</para>
</sect2>
<sect2 xml:id="releng-ports-beta-rc">
<title>Ports Changes During <literal>BETA</literal>,
<literal>RC</literal>, and the Final
<literal>RELEASE</literal></title>
<para>For each build during the release cycle, the
<literal>MANIFEST</literal> files containing the
<literal>SHA256</literal> of the various distribution sets, such
as <literal>base.txz</literal>, <literal>kernel.txz</literal>,
and so on, are added to the
<package>misc/freebsd-release-manifests</package> port. This
allows utilities other than &man.bsdinstall.8;, such as
<package>ports-mgmt/poudriere</package>, to safely use these
distribution sets by providing a mechanism through which the
checksums can be verified.</para>
</sect2>
</sect1>