git: 72a86c01df - main - Upgrade committers-guide and freebsd-releng with the new doc tech.
Sergio Carlavilla Delgado
carlavilla at FreeBSD.org
Sat Mar 20 18:36:22 UTC 2021
The branch main has been updated by carlavilla:
URL: https://cgit.FreeBSD.org/doc/commit/?id=72a86c01dfbce05e33204e59716ad6f64bd5880d
commit 72a86c01dfbce05e33204e59716ad6f64bd5880d
Author: Sergio Carlavilla Delgado <carlavilla at FreeBSD.org>
AuthorDate: 2021-03-20 18:34:29 +0000
Commit: Sergio Carlavilla Delgado <carlavilla at FreeBSD.org>
CommitDate: 2021-03-20 18:34:29 +0000
Upgrade committers-guide and freebsd-releng with the new doc tech.
Upgrade committers-guide and freebsd-releng to show the new
documentation tech - Hugo/AsciiDoctor
---
.../en/articles/committers-guide/_index.adoc | 2 +-
.../content/en/articles/freebsd-releng/_index.adoc | 67 ++++++++--------------
2 files changed, 26 insertions(+), 43 deletions(-)
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 3f39b45571..e9ea2cb9c3 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -4558,7 +4558,7 @@ In particular, we recommend that you read:
+
[NOTE]
====
-Get your mentor to add you to the "Additional Contributors" ([.filename]#doc/en_US.ISO8859-1/articles/contributors/contrib.additional.xml#), if you are not already listed there.
+Get your mentor to add you to the "Additional Contributors" ([.filename]#~/documentation/content/en/articles/contributors/contrib-additional.adoc#), if you are not already listed there.
====
* <<developer.relations>>
* <<ssh.guide>>
diff --git a/documentation/content/en/articles/freebsd-releng/_index.adoc b/documentation/content/en/articles/freebsd-releng/_index.adoc
index 48124f6881..65410cf4a0 100644
--- a/documentation/content/en/articles/freebsd-releng/_index.adoc
+++ b/documentation/content/en/articles/freebsd-releng/_index.adoc
@@ -207,26 +207,19 @@ The same applies to work-in-progress extensions.
For example, in-progress work for a new device driver that is otherwise isolated from the rest of the tree may be granted an extension.
A new scheduler, however, may not be feasible, especially if such dramatic changes do not exist in another branch.
-The schedule is also added to the Project website, in the `doc/` repository, in [.filename]#head/en_US.ISO8859-1/htdocs/releases/{branchRevision}R/schedule.xml#. This file is continuously updated as the release cycle progresses.
+The schedule is also added to the Project website, in the `doc/` repository, in [.filename]#~/website/content/en/releases/{branchRevision}R/schedule.adoc#. This file is continuously updated as the release cycle progresses.
[NOTE]
====
-In most cases, the [.filename]#schedule.xml# can be copied from a prior release and updated accordingly.
+In most cases, the [.filename]#schedule.adoc# can be copied from a prior release and updated accordingly.
====
-In addition to adding [.filename]#schedule.xml# to the website, [.filename]#head/shared/xml/navibar.ent# and [.filename]#head/shared/xml/release.ent# are also updated to add the link to the schedule to various subpages, as well as enabling the link to the schedule on the Project website index page.
+In addition to adding [.filename]#schedule.adoc# to the website, [.filename]#~/shared/releases.adoc# is also updated to add the link to the schedule to various subpages, as well as enabling the link to the schedule on the Project website index page.
-The schedule is also linked from [.filename]#head/en_US.ISO8859-1/htdocs/releng/index.xml#.
+The schedule is also linked from [.filename]#~/website/content/en/releng/_index.adoc#.
Approximately one month prior to the scheduled "code slush", the {teamRe} sends a reminder email to the FreeBSD Developers.
-Once the first builds of the release cycle are available, update the `beta.local.where` entity in [.filename]#head/en_US.ISO8859-1/htdocs/releases/{branchRevision}R/schedule.xml#. replacing `IGNORE` with `INCLUDE`.
-
-[NOTE]
-====
-If two parallel release cycles are happening at once, the `beta2.local.where` entity may be used instead.
-====
-
[[releng-terms]]
== Release Engineering Terminology
@@ -284,17 +277,12 @@ When the release cycle schedule is available, these files need to be updated to
| File to Edit
| What to Change
-|[.filename]#share/xml/release.ent#
-|Change `beta.upcoming` from `IGNORE` to `INCLUDE`
-
-|[.filename]#share/xml/release.ent#
-|Change `% beta.upcoming` from `IGNORE` to `INCLUDE`
+|[.filename]#~/shared/releases.adoc#
+|Change `beta-upcoming` from `IGNORE` to `INCLUDE`
-|[.filename]#share/xml/release.ent#
-|Change `beta.testing` from `IGNORE` to `INCLUDE`
+|[.filename]#~/shared/releases.adoc#
+|Change `beta-testing` from `IGNORE` to `INCLUDE`
-|[.filename]#share/xml/release.ent#
-|Change `% beta.testing` from `IGNORE` to `INCLUDE`
|===
[[releng-website-beta-rc]]
@@ -308,19 +296,16 @@ When transitioning from `PRERELEASE` to `BETA`, these files need to be updated t
| File to Edit
| What to Change
-|[.filename]#en_US.ISO8859-1/htdocs/releases/12.0R/schedule.xml#
-|Change `% beta.local.where` `IGNORE` to `INCLUDE`
+|[.filename]#share/releases.adoc#
+|Update `betarel-vers` to `BETA__1__`
-|[.filename]#share/xml/release.ent#
-|Update `% betarel.vers` to `BETA__1__`
-
-|[.filename]#share/xml/news.xml#
+|[.filename]#~/website/data/en/news.toml#
|Add an entry announcing the `BETA`
-|[.filename]#en_US.ISO8859-1/htdocs/security/advisory-template.txt#
+|[.filename]#~/website/static/security/advisory-template.txt#
|Add the new `BETA`, `RC`, or final `RELEASE` to the template
-|[.filename]#en_US.ISO8859-1/htdocs/security/errata-template.txt#
+|[.filename]#~/website/static/security/errata-template.txt#
|Add the new `BETA`, `RC`, or final `RELEASE` to the template
|===
@@ -500,8 +485,6 @@ These files are all relative to the top-most level of the stable branch:
|Add a new `.ds` entry for the FreeBSD version, and update `doc-default-operating-system` (FreeBSD 11.x and earlier only)
|===
-In the `doc` repository, also update [.filename]#head/en_US.ISO8859-1/htdocs/releases/12.0R/Makefile.hardware#, switching the value of `_BRANCH` to `BETA__X__`, `RC__X__`, or `RELEASE`, respectively.
-
[[releng-stable-builds-beta]]
=== FreeBSD `BETA` Builds
@@ -575,7 +558,7 @@ The order of commits and what to change are:
% svn commit {branchStablex}
....
-Now that two new `__FreeBSD_version` values exist, also update [.filename]#head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml# in the Documentation Project repository.
+Now that two new `__FreeBSD_version` values exist, also update [.filename]#~/documentation/content/en/books/porters-handbook/versions/chapter.adoc# in the Documentation Project repository.
After the first `RC` build has completed and tested, the {branchStable} branch can be "thawed" by removing (or commenting) the ^/{branchStablex} entry in [.filename]#svnadmin/conf/approvers#.
@@ -853,27 +836,27 @@ When a release reaches End-of-Life, references to that release should be removed
| What to Change
-|[.filename]#head/en_US.ISO8859-1/htdocs/index.xsl#
-|Remove `&u.relXXX.announce;` and `&u.relXXX.current;` references.
+|[.filename]#~/website/themes/beastie/layouts/index.html#
+|Remove `u-relXXX-announce` and `u-relXXX-announce` references.
-|[.filename]#head/en_US.ISO8859-1/htdocs/releases/index.xml#
-|Move the &u.relXXX.*; macros from the supported release list to the Legacy Releases list.
+|[.filename]#~/website/content/en/releases/_index.adoc#
+|Move the `u-relXXX-*` variables from the supported release list to the Legacy Releases list.
-|[.filename]#head/en_US.ISO8859-1/htdocs/releng/index.xml#
+|[.filename]#~/website/content/en/releng/_index.adoc#
|Update the appropriate releng branch to refelect the branch is no longer supported.
-|[.filename]#head/en_US.ISO8859-1/htdocs/security/security.xml#
+|[.filename]#~/website/content/en/security/_index.adoc#
|Remove the branch from the supported branch list.
-|[.filename]#head/en_US.ISO8859-1/htdocs/where.xml#
+|[.filename]#~/website/content/en/where.adoc#
|Remove the URLs for the release.
-|[.filename]#head/share/xml/navibar.ent#
-|Remove `&u.relXXX.announce;` and `&u.relXXX.current;` references.
+|[.filename]#~/website/themes/beastie/layouts/partials/sidenav.html#
+|Remove `u-relXXX-announce` and `u-relXXX-announce` references.
-|[.filename]#head/en_US.ISO8859-1/htdocs/security/advisory-template.txt#
+|[.filename]#~/website/static/security/advisory-template.txt#
|Remove references to the release and releng branch.
-|[.filename]#head/en_US.ISO8859-1/htdocs/security/errata-template.txt#
+|[.filename]#~/website/static/security/errata-template.txt#
|Remove references to the release and releng branch.
|===
More information about the dev-commits-doc-all
mailing list