Skip to content

Commit f783211

Browse files
committed
[skip netlify] 4.8 GA
1 parent 729b2b1 commit f783211

12 files changed

+54
-68
lines changed

.s2i/httpd-cfg/01-commercial.conf

+3-3
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ AddType text/vtt vtt
140140

141141
# Redirects for "latest" version
142142
RewriteRule ^(container-platform|enterprise)/?$ /container-platform/latest [R=301]
143-
RewriteRule ^(container-platform|enterprise)/latest/?(.*)$ /container-platform/4\.7/$2 [NE,R=301]
143+
RewriteRule ^(container-platform|enterprise)/latest/?(.*)$ /container-platform/4\.8/$2 [NE,R=301]
144144
RewriteRule ^(online)/(3\.0|3\.1|3\.2|3\.3|3\.4|3\.5|3\.6|3\.7|3\.9|3\.10|3\.11|latest)/?(.*)$ /$1/pro/$3 [NE,R=301]
145145

146146
# Release notes redirects
@@ -349,8 +349,8 @@ AddType text/vtt vtt
349349
RewriteRule ^rosa/?$ /rosa/welcome/index.html [L,R=301]
350350
RewriteRule ^enterprise/(3\.0|3\.1|3\.2)/?$ /enterprise/$1/welcome/index.html [L,R=301]
351351
RewriteRule ^enterprise/3\.3/?$ /container-platform/3.3/welcome/index.html [L,R=301]
352-
RewriteRule ^container-platform/(3\.3|3\.4|3\.5|3\.6|3\.7|3\.9|3\.10|3\.11|4\.1|4\.2|4\.3|4\.4|4\.5|4\.6|4\.7)/?$ /container-platform/$1/welcome/index.html [L,R=301]
353-
RewriteRule ^container-platform-ocp/(4\.3|4\.4)/?$ /container-platform-ocp/$1/welcome/index.html [L,R=301]
352+
RewriteRule ^container-platform/(3\.3|3\.4|3\.5|3\.6|3\.7|3\.9|3\.10|3\.11|4\.1|4\.2|4\.3|4\.4|4\.5|4\.6|4\.7|4\.8)/?$ /container-platform/$1/welcome/index.html [L,R=301]
353+
RewriteRule ^container-platform-ocp/(4\.3|4\.4|4\.8)/?$ /container-platform-ocp/$1/welcome/index.html [L,R=301]
354354

355355

356356
# Redirects for 4.2

README.adoc

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
= OpenShift documentation
22

3-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
4-
53
* https://www.okd.io/[OKD]
64
* https://www.openshift.com/products/online/[OpenShift Online]
75
* https://www.openshift.com/products/container-platform/[OpenShift Container Platform]

_templates/_page_openshift.html.erb

+5-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<body onload="selectVersion('<%= version %>');">
2828
<%= render("_templates/_topnav.html.erb", :distro_key => distro_key) %>
2929
<%
30-
unsupported_versions = ["3.0", "3.1", "3.2", "3.3", "3.4", "3.5", "3.6", "3.7", "3.9", "3.10", "4.1", "4.2", "4.3", "4.4"];
30+
unsupported_versions = ["3.0", "3.1", "3.2", "3.3", "3.4", "3.5", "3.6", "3.7", "3.9", "3.10", "4.1", "4.2", "4.3", "4.4", "4.5"];
3131
%>
3232
<div class="container">
3333
<p class="toggle-nav visible-xs pull-left">
@@ -49,9 +49,10 @@
4949
</a>
5050
<% end %>
5151
<select id="version-selector" onchange="versionSelector(this);">
52-
<% if (version == "4.8") %>
53-
<option value="4.8">4.8</option>
52+
<% if (version == "4.9") %>
53+
<option value="4.9">4.9</option>
5454
<% end %>
55+
<option value="4.8">4.8</option>
5556
<option value="4.7">4.7</option>
5657
<option value="4.6">4.6</option>
5758
<option value="4.5">4.5</option>
@@ -135,7 +136,7 @@
135136
<div class="page-header">
136137
<h1><%= article_title %></h1>
137138
</div>
138-
<% if (version == "4.8") %>
139+
<% if (version == "4.9" || distro_key == "openshift-wescale") %>
139140
<font size="+1" color="red">This documentation is work in progress and might not be complete or fully tested.</font>
140141
<div id="annoying-box"
141142
style="position: fixed; top: 100px; left: 10px; width: 100px; height: 100px; color: red">

contributing_to_docs/contributing.adoc

+7-11
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ toc::[]
1010

1111
== Different ways to contribute
1212

13-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
14-
1513
There are a few different ways you can contribute to OpenShift documentation:
1614

1715
// * Submit comments at the bottom of each topic (still awaiting implementation)
@@ -124,33 +122,31 @@ file.
124122

125123
== Release branches
126124

127-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
128-
129125
With the combination of conditionalizing content within files with
130126
`ifdef/endif` and conditionalizing whole files in the `&#95;topic&#95;map.yml`
131-
file, the `master` branch of
127+
file, the `main` branch of
132128
this repository always contains a complete set of documentation for all
133129
OpenShift products. However, when and as new versions of an OpenShift product
134-
are released, the `master` branch is merged down to new or existing release
130+
are released, the `main` branch is merged down to new or existing release
135131
branches. Here is the general naming scheme used in the branches:
136132

137-
* `master` - This is our *working* branch.
133+
* `main` - This is our *working* branch.
138134
* `enterprise-N.N` - OpenShift Container Platform support releases. The docs
139135
for OpenShift Online and OpenShift Dedicated are based on the appropriate
140136
`enterprise-N.N` branch.
141137

142138
On a 12-hourly basis, the documentation web sites are rebuilt for each of these
143139
branches. This way the published content for each released version of an
144140
OpenShift product will remain the same while development continues on the
145-
`master` branch. Additionally, any corrections or additions that are
141+
`main` branch. Additionally, any corrections or additions that are
146142
"cherry-picked" into the release branches will show up in the published
147143
documentation after 12 hours.
148144

149145
[NOTE]
150146
====
151-
All OpenShift content development for the 4.x stream occurs on the `master`, or
147+
All OpenShift content development for the 4.x stream occurs on the `main`, or
152148
*working* branch.
153-
Therefore, when submitting your work the PR must be created against the `master`
149+
Therefore, when submitting your work the PR must be created against the `main`
154150
branch. After it is reviewed, a writer will apply the content to the relevant
155151
release branches. If you know which branches a change applies to, be sure to
156152
specify it in your PR.
@@ -162,7 +158,7 @@ branch against enterprise-3.11 to submit your changes.
162158
== Adding files to the collection
163159
After you create files, you must add them to the `&#95;topic&#95;map.yml` so
164160
that the build system can render them. The documentation build system reads
165-
the `&#95;distro&#95;map.yml` from the master branch to determine
161+
the `&#95;distro&#95;map.yml` from the main branch to determine
166162
which branches to build and then the `&#95;topic&#95;map.yml` file
167163
for each of the branches
168164
to construct the content from the source files and publish to the relevant

contributing_to_docs/contributing_user_stories.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
toc::[]
1010

1111
== Modularization backstory
12-
OpenShift docs are getting modularized, starting from OpenShift 4.1.
13-
All existing content will be completely replaced with content that is based on user stories and
12+
OpenShift docs are modularized, starting from OpenShift 4.1.
13+
All existing content has been replaced with content that is based on user stories and
1414
complies with the modularization guidelines. All future content must both
1515
support a user story and be modular.
1616

contributing_to_docs/create_or_edit_content.adoc

+21-31
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,23 @@ your local source branch is in sync with the remote and that you have all the
2424
latest changes. You must also ensure that your forked repository is also in sync
2525
with the remote repository.
2626

27-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
28-
2927
[NOTE]
3028
====
31-
Because most changes in this repository must be committed to the `master`
32-
branch (which is the master for the 4.x stream), the following process always
33-
uses `master` as the name of the source
29+
Because most changes in this repository must be committed to the `main`
30+
branch (which is the main for the 4.x stream), the following process always
31+
uses `main` as the name of the source
3432
branch. If you must use another branch as the source for your change, make
35-
sure that you consistently use that branch name instead of `master`.
33+
sure that you consistently use that branch name instead of `main`.
3634
3735
When adding or updating content for version 3.11, you should create a feature
3836
branch against enterprise-3.11 to submit your changes.
3937
====
4038

41-
1. From your local repository, make sure you have the `master` branch checked
39+
1. From your local repository, make sure you have the `main` branch checked
4240
out:
4341
+
4442
----
45-
$ git checkout master
43+
$ git checkout main
4644
----
4745

4846
2. Fetch the current state of the OpenShift documentation repository:
@@ -55,14 +53,14 @@ $ git fetch upstream
5553
`openshift/openshift-docs`, into your local repository:
5654
+
5755
----
58-
$ git rebase upstream/master
56+
$ git rebase upstream/main
5957
----
6058

6159
4. Push the latest updates to your forked repository so that it is also in sync
6260
with the remote:
6361
+
6462
----
65-
$ git push origin master
63+
$ git push origin main
6664
----
6765

6866
== Add content or update existing content on local branch
@@ -116,15 +114,13 @@ commit those changes locally:
116114
$ git commit -am "Detailed comments about what changes were made; for example, fixed typo"
117115
----
118116

119-
*Step 5:* Rebase updates from `master` into your working branch
120-
121-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
117+
*Step 5:* Rebase updates from `main` into your working branch
122118

123119
Remember that you must rebase against the branch that you created this working
124-
branch from. In most cases, it will be the master branch for the 4.x stream.
120+
branch from. In most cases, it will be the main branch for the 4.x stream.
125121

126122
----
127-
$ git rebase upstream/master
123+
$ git rebase upstream/main
128124
----
129125

130126
[NOTE]
@@ -144,16 +140,14 @@ $ git push origin <working_branch>
144140

145141
== Submit PR to merge your work
146142

147-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
148-
149143
When you have pushed your changes to your GitHub account, you can submit a PR to
150-
have your work from your GitHub fork to the `master` branch of the OpenShift
144+
have your work from your GitHub fork to the `main` branch of the OpenShift
151145
documentation repository. The documentation team will review the work, advise of
152146
any further changes that are required, and finally merge your work.
153147

154148
1. Go to your forked GitHub repository on the GitHub website, and you should see
155149
your local branch that includes all of your work.
156-
2. Click on *Pull Request* to submit the PR against the `master` branch of the
150+
2. Click on *Pull Request* to submit the PR against the `main` branch of the
157151
`openshift-docs` repository.
158152
3. If you know which product versions your change applies to, include a comment
159153
that specifies the minimum version that the change applies to. The docs team
@@ -163,18 +157,16 @@ applied to one or more of these branches.
163157

164158
== Confirm your changes have been merged
165159

166-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
160+
When your PR has been merged into the `main` branch, you should confirm and
161+
then sync your local and GitHub repositories with the `main` branch.
167162

168-
When your PR has been merged into the `master` branch, you should confirm and
169-
then sync your local and GitHub repositories with the `master` branch.
170-
171-
1. On your workstation, switch to the `master` branch:
163+
1. On your workstation, switch to the `main` branch:
172164
+
173165
----
174-
$ git checkout master
166+
$ git checkout main
175167
----
176168

177-
2. Pull the latest changes from `master`:
169+
2. Pull the latest changes from `main`:
178170
+
179171
----
180172
$ git fetch upstream
@@ -184,14 +176,14 @@ $ git fetch upstream
184176
`openshift/openshift-docs`, into your local repository:
185177
+
186178
----
187-
$ git rebase upstream/master
179+
$ git rebase upstream/main
188180
----
189181

190182
4. After confirming in your rebased local repository that your changes have been
191183
merged, push the latest changes, including your work, to your GitHub account:
192184
+
193185
----
194-
$ git push origin master
186+
$ git push origin main
195187
----
196188

197189
== Add changes to an existing PR, if required
@@ -223,10 +215,8 @@ existing PR. Sometimes a refresh of your browser may be required.
223215

224216
== Delete the local working branch
225217

226-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
227-
228218
When you have confirmed that all of your changes have been accepted and merged,
229-
and you have pulled the latest changes on `master` and pushed them to your
219+
and you have pulled the latest changes on `main` and pushed them to your
230220
GitHub account, you can delete the local working branch. Ensure you are in your
231221
local repository before proceeding.
232222

contributing_to_docs/doc_guidelines.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ toc::[] <6>
3939
+
4040
[NOTE]
4141
====
42-
The `{product-name}` and `{product-version}` common attributes are not defined in the `modules/common-attributes.adoc` file. Those attributes are pulled by AsciiBinder from the distro mapping definitions in the https://github.com/openshift/openshift-docs/blob/master/_distro_map.yml[_distro_map.yml] file. See xref:product-name-and-version[Product name and version] for more information on this topic.
42+
The `{product-name}` and `{product-version}` common attributes are not defined in the `modules/common-attributes.adoc` file. Those attributes are pulled by AsciiBinder from the distro mapping definitions in the https://github.com/openshift/openshift-docs/blob/main/_distro_map.yml[_distro_map.yml] file. See xref:product-name-and-version[Product name and version] for more information on this topic.
4343
====
4444
+
4545
<4> Context used for identifying headers in modules that is the same as the anchor id. Example: cli-developer-commands.
@@ -262,7 +262,7 @@ When needed, use `.Prerequisites`, `.Next steps`, or `.Additional resources` syn
262262
When possible, generalize references to the product name and/or version by using
263263
the `{product-title}` and/or `{product-version}` attributes. These attributes
264264
are pulled by AsciiBinder from the distro mapping definitions in the
265-
https://github.com/openshift/openshift-docs/blob/master/_distro_map.yml[_distro_map.yml]
265+
https://github.com/openshift/openshift-docs/blob/main/_distro_map.yml[_distro_map.yml]
266266
file.
267267

268268
The `{product-title}` comes from the first `name:` field in a distro mapping,
@@ -301,7 +301,7 @@ You can deploy applications on {product-title}.
301301
----
302302

303303
This is a safe statement that could appear in probably any of the builds, so an
304-
https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/contributing.adoc#conditional-text-between-products[ifdef/endif
304+
https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/contributing.adoc#conditional-text-between-products[ifdef/endif
305305
statement] is not necessary. For example, if you were viewing a build for the
306306
`openshift-enterprise` distro (for any of the distro-defined branches), this
307307
would render as:

contributing_to_docs/tools_and_setup.adoc

+6-8
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,9 @@ workstation to edit existing content or create content.
138138

139139
=== How to deploy to your own OpenShift cluster for testing
140140

141-
> **NOTE**: The OpenShift docs team will rename the master branch to the main branch at 4.8 GA.
142-
143141
You can deploy to your own OpenShift cluster for development. This process will use your github repo to launch the website,
144-
and therefore your github repo must have all of the upstream branches. `master` is used for site changes,
145-
so assuming all your work is in `master`, you can remove all remote branches and then push the upstream branches.
142+
and therefore your github repo must have all of the upstream branches. `main` is used for site changes,
143+
so assuming all your work is in `main`, you can remove all remote branches and then push the upstream branches.
146144

147145

148146
Removing remote branches and updating with upstream branches (this assumes remote repos called `origin` and `upstream`)
@@ -153,10 +151,10 @@ by performing the below commands.
153151
====
154152
----
155153
$ git fetch --all
156-
$ for branch in $(git branch -r | grep -v "master" | grep "^ origin"); do git push origin --delete $(echo $branch | cut -d '/' -f 2); done
157-
$ git branch -D $(git branch | grep -v 'master' | xargs)
158-
$ for branch in $(git branch -r | grep -v "master" | grep "^ upstream"); do git branch --track $(echo $branch | cut -d '/' -f 2) $(echo $branch | tr -d '[:space:]'); done
159-
$ for branch in $(git branch | grep -v "master"); do git push origin $(echo $branch | tr -d '[:space:]'); done
154+
$ for branch in $(git branch -r | grep -v "main" | grep "^ origin"); do git push origin --delete $(echo $branch | cut -d '/' -f 2); done
155+
$ git branch -D $(git branch | grep -v 'main' | xargs)
156+
$ for branch in $(git branch -r | grep -v "main" | grep "^ upstream"); do git branch --track $(echo $branch | cut -d '/' -f 2) $(echo $branch | tr -d '[:space:]'); done
157+
$ for branch in $(git branch | grep -v "main"); do git push origin $(echo $branch | tr -d '[:space:]'); done
160158
----
161159

162160
Deploying the docs site to an OpenShift cluster

index-commercial.html

+3
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ <h2>OpenShift Container Platform</h2>
189189
<div class="btn-group">
190190
<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Select Version<span class="caret"></span></button>
191191
<ul class="dropdown-menu" role="menu">
192+
<li><a href="container-platform/4.8/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 4.8</a></li>
192193
<li><a href="container-platform/4.7/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 4.7</a></li>
193194
<li><a href="container-platform/4.6/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 4.6</a></li>
194195
<li><a href="container-platform/4.5/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 4.5</a></li>
@@ -259,6 +260,7 @@ <h2>OpenShift Container Platform <font size="-1">(日本語翻訳)</font></h2>
259260
<div class="btn-group">
260261
<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">バージョンを選択する<span class="caret"></span></button>
261262
<ul class="dropdown-menu" role="menu">
263+
<li><a href="https://access.redhat.com/documentation/ja-jp/openshift_container_platform/4.8/"><i class="fa fa-arrow-circle-o-right"></i> 4.8</a></li>
262264
<li><a href="https://access.redhat.com/documentation/ja-jp/openshift_container_platform/4.7/"><i class="fa fa-arrow-circle-o-right"></i> 4.7</a></li>
263265
<li><a href="https://access.redhat.com/documentation/ja-jp/openshift_container_platform/4.6/"><i class="fa fa-arrow-circle-o-right"></i> 4.6</a></li>
264266
<li><a href="https://access.redhat.com/documentation/ja-jp/openshift_container_platform/4.5/"><i class="fa fa-arrow-circle-o-right"></i> 4.5</a></li>
@@ -275,6 +277,7 @@ <h2>OpenShift Container Platform <font size="-1">(中文文档)</font></h2>
275277
<div class="btn-group">
276278
<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">选择版本<span class="caret"></span></button>
277279
<ul class="dropdown-menu" role="menu">
280+
<li><a href="https://access.redhat.com/documentation/zh-cn/openshift_container_platform/4.8/"><i class="fa fa-arrow-circle-o-right"></i> 4.8</a></li>
278281
<li><a href="https://access.redhat.com/documentation/zh-cn/openshift_container_platform/4.7/"><i class="fa fa-arrow-circle-o-right"></i> 4.7</a></li>
279282
<li><a href="https://access.redhat.com/documentation/zh-cn/openshift_container_platform/4.6/"><i class="fa fa-arrow-circle-o-right"></i> 4.6</a></li>
280283
<li><a href="https://access.redhat.com/documentation/zh-cn/openshift_container_platform/4.5/"><i class="fa fa-arrow-circle-o-right"></i> 4.5</a></li>

issue_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
Please submit only documentation-related issues with this form, or follow the
3-
Contribute to OpenShift guidelines (https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/contributing.adoc) to submit a PR.
3+
Contribute to OpenShift guidelines (https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/contributing.adoc) to submit a PR.
44
-->
55

66
### Which section(s) is the issue in?

0 commit comments

Comments
 (0)