Skip to content

Commit 19e4223

Browse files
Add 'RC' DocState (#4158)
* Add 'RC' DocState * Update README with step to set 'RC' DocState
1 parent 9422fd2 commit 19e4223

File tree

4 files changed

+22
-3
lines changed

4 files changed

+22
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ When a commit is pushed into `X.Y`:
6363
* On `master`, pull the latest changes and create a new `X.Y` branch.
6464
* On the `X.Y` branch:
6565
* Update `guides/common/attributes.adoc`.
66-
* Set `DocState` to `unsupported`.
66+
* Set `DocState` to `RC`.
6767
* Set `ProjectVersion` to `X.Y` and set the matching `KatelloVersion`.
6868
* Push into the `X.Y` branch.
6969
* Notify the Doc team on the [TheForeman Doc chat](https://matrix.to/#/#theforeman-doc:matrix.org) Matrix channel.

guides/common/attributes.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
// Document state: "nightly" for master, "stable" for last two releases,
2-
// "unsupported" for the rest and "satellite" for satellite build
1+
// Document state: "nightly" for master,
2+
// "RC" for release candidate,
3+
// "stable" for the last two (supported) releases,
4+
// "unsupported" for the rest,
5+
// "satellite" for satellite build
36
:DocState: nightly
47

58
// Version numbers

guides/common/header.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ ifeval::["{DocState}" == "nightly"]
1111
:revnumber: Nightly
1212
:revdate: published {date_my}
1313
endif::[]
14+
ifeval::["{DocState}" == "RC"]
15+
:revnumber: {ProjectVersion} (release candidate)
16+
:revdate: published {date_my}
17+
endif::[]
1418
ifeval::["{DocState}" == "stable"]
1519
:revnumber: {ProjectVersion}
1620
:revdate: published {date_mdy}

guides/common/ribbons.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ Report issue
1010
</a>
1111
++++
1212
endif::[]
13+
ifeval::["{DocState}" == "RC"]
14+
++++
15+
<!-- "Fork me on GitHub" CSS ribbon v0.2.3 | MIT License -->
16+
<!-- https://github.com/simonwhitaker/github-fork-ribbon-css -->
17+
<a class="release-ribbon right-top fixed" data-ribbon="Release candidate" title="Release candidate">
18+
Pre-release version
19+
</a>
20+
<a class="issue-ribbon right-bottom fixed" href="https://github.com/theforeman/foreman-documentation/issues/new" data-ribbon="Report issue" title="Report issue">
21+
Report issue
22+
</a>
23+
++++
24+
endif::[]
1325
ifeval::["{DocState}" == "stable"]
1426
++++
1527
<!-- "Fork me on GitHub" CSS ribbon v0.2.3 | MIT License -->

0 commit comments

Comments
 (0)