OADP-2736 to OCP 4.12

.devcontainer/devcontainer.json

@@ -0,0 +1,4 @@
+{
+  "image":"mcr.microsoft.com/devcontainers/universal:2",
+  "postCreateCommand": "sleep 30 && docker run --rm -it -v `pwd`:/docs:Z quay.io/openshift-cs/asciibinder sh -c \"git config --global --add safe.directory /docs && asciibinder build --distro openshift-rosa && asciibinder build --distro openshift-enterprise\" && python3 -m http.server -d ./_preview"
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+@kalexand-rh @JoeAldinger @bergerhoffer @adellape @sjhala-ccs @apinnick @ousleyp

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+<!--- PR title format: [GH#<gh-issue-id>][BZ#<bz-issue-id>][OCPBUGS#<jira-issue-id>][OSDOCS#<jira-issue-id>]: <short-description-of-the-pr> --->
+
+<!--- If your changes apply to the latest release and/or in-development version of OpenShift, open your PR against the `main` branch.
+
+* For more details about the information requested in this template, see:
+  https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/create_or_edit_content.adoc#submit-PR --->
+
+Version(s):
+<!--- Specify the version or versions of OpenShift your PR applies to. -->
+
+Issue:
+<!--- Add a link to the Bugzilla, Jira, or GitHub issue, if applicable. --->
+
+Link to docs preview:
+<!--- Add direct link(s) to the exact page(s) with updated content from the preview build. --->
+
+QE review:
+- [ ] QE has approved this change.
+<!--- QE approval is required to merge a PR except for changes that do not impact the meaning of the docs. --->
+
+Additional information:
+<!--- Optional: Include additional context or expand the description here.--->
+
+<!--- After you open your PR, ask for review from the OpenShift docs team:
+  For community authors: Tag @openshift/team-documentation in a GitHub comment.--->

.gitignore

@@ -9,7 +9,12 @@ architecture/core_concepts/images/docker-diagram.png.cache
 dev_guide/builds/images/chained-build.png
 dev_guide/builds/images/chained-build.png.cache
 .DS_Store
+.idea
 .venv
 .gem
 bin
 commercial_package
+.vscode
+.vale/styles/AsciiDoc
+.vale/styles/OpenShiftAsciiDoc
+.vale/styles/RedHat

.gitpod.yml

@@ -0,0 +1,16 @@
+#image:
+#  file: .gitpod.Dockerfile
+
+tasks:
+  - name: Dev Server
+    # before: npm install --global http-server
+    init: |
+      rvm install 2.7.6
+      gem install asciidoctor asciidoctor-diagram ascii_binder
+#      pip3 install aura.tar.gz
+    command: |
+      asciibinder build --distro=openshift-enterprise
+      BR="$(git branch --show-current)"
+      cd _preview/openshift-enterprise/$BR
+      ln -s welcome/index.html index.html
+      python -m http.server

.s2i/bin/assemble

@@ -5,8 +5,12 @@
 # Required to install `ffi` separately due to an installation issue with ffi v-1.9.21
 echo "---> Installing ffi ..."
 gem install ffi --version 1.9.18
+# Required to install `asciidoctor-diagram` separately due to a "undefined method `enable_dsl'" error with asciidoctor-diagram v-1.5.17
+echo "---> Installing asciidoctor-diagram ..."
+gem install asciidoctor-diagram --version 1.5.16
 # `gem install` is required because `bundle install` does not properly place `asciibinder` into $PATH
 echo "---> Installing AsciiBinder ..."
+# gem install ascii_binder --version 0.1.15.1
 gem install ascii_binder
 
 # Move git repository to local working directory
@@ -20,7 +24,7 @@ echo "---> Fetching remote branches"
 # it's necessary to enforce a * ref so that all branches are referenced
 sed -i 's%fetch = +refs.*%fetch = +refs/heads/*:refs/remotes/origin/*%' .git/config
 git fetch --all --quiet
-for remote in $(git branch -r | egrep -v "(>|$(git rev-parse --abbrev-ref HEAD))|master"); do git checkout --force --track $remote; done
+for remote in $(git branch -r | egrep -v "(>|$(git rev-parse --abbrev-ref HEAD))$|master$"); do git checkout --force --track $remote; done
 git checkout master
 
 # Fixes incompatible character encodings: US-ASCII and UTF-8 error
@@ -32,40 +36,91 @@ git config user.email "devel@openshift.com"
 # Package assets for commercial site only, without Minishift content
 asciibinder package --site=commercial
 # Move commercial content to its own directory, including commercial specific redirects and 404 page
+
 mkdir commercial_package
 mv _package/commercial commercial_package
 git checkout master
 mkdir commercial_package/commercial/httpd-cfg
 mv .s2i/httpd-cfg/01-commercial.conf commercial_package/commercial/httpd-cfg
 mv 404-commercial.html commercial_package/commercial/404.html
 
+# minishift docs only need to be on 3.x
+
+git checkout enterprise-3.11
 echo "---> Installing Minishift content ..."
 mkdir minishift
 cd minishift
-if wget http://artifacts.ci.centos.org/minishift/minishift/docs/latest/minishift-adoc.tar ; then
+if wget http://minishift.io/minishift-adoc.tar ; then
     tar -xvf minishift-adoc.tar --strip 1
     cat _topic_map.yml >> ../_topic_map.yml
     rm minishift-adoc.tar
     cd ..
-    git add .
+    git add minishift/
     git commit -am "Minishift build-time commit"
 else
     echo "WARNING: Could not retrieve minishift-adoc.tar"
     cd ..
     rmdir minishift
 fi
 
+# checking back into master before resuming the packaging of the community content
+git checkout master
+
 echo "---> AsciiBinder packaging community content ..."
 # Package assets for community site only, with Minishift content
 asciibinder package --site=community
 # Move community content to its own directory, including community specific redirects and 404 page
+
 mkdir community_package
 mv _package/community community_package
 git checkout master
 mkdir community_package/community/httpd-cfg
 mv .s2i/httpd-cfg/01-community.conf community_package/community/httpd-cfg
 mv 404-community.html community_package/community/404.html
 
+# Optionally install .htaccess files to gate access to staging content
+# Define a HTACCESS_DIRS environment variable with ':' delimited directories
+# Reference directory like "commercial_package/commercial/container-platform/3.10:community_package/community/latest" for docs.openshift.com/container-platform/3.10 and docs.okd.io/latest
+if [[ ! -z "$HTACCESS_DIRS" ]]; then
+    echo "---> Creating .htaccess/.htpasswd files"
+    IFS=':'; directories=($HTACCESS_DIRS); unset IFS;
+    for dir in "${directories[@]}"; do
+        echo "--->     Adding .htpasswd protection to $dir"
+
+        # brute force separate password for container-platform-ocp distribution
+        if [ $dir = "commercial_package/commercial/container-platform-ocp/4.3" ] || [ $dir = "commercial_package/commercial/container-platform-ocp/4.4" ] || [ $dir = "commercial_package/commercial/container-platform-ocp/4.7" ]; then
+          echo "--->     separate .htpasswd protection to $dir"
+
+          echo -e 'AuthType Basic\nAuthName "Access to the stage docs"\nAuthUserFile /opt/app-root/src/.htpasswdocp\nRequire valid-user' > $dir/.htaccess
+
+          echo 'openshift:$apr1$c41fpuxh$jHe/W0gYLffn6501Cx2TS/' > commercial_package/commercial/.htpasswdocp
+        else
+          echo -e 'AuthType Basic\nAuthName "Access to the stage docs"\nAuthUserFile /opt/app-root/src/.htpasswd\nRequire valid-user' > $dir/.htaccess
+        fi
+
+    done
+    echo 'redhat:$apr1$1HYe8rB6$6pa5OVd01quYUYl8ymyqK0' > commercial_package/commercial/.htpasswd
+    echo 'redhat:$apr1$1HYe8rB6$6pa5OVd01quYUYl8ymyqK0' > community_package/community/.htpasswd
+fi
+
+# Optionally restrict crawlers from indexing the content
+# Define a DISALLOW_CRAWL_DIRS environment variable with ':' delimited directories
+# Reference directory like "commercial_package/commercial/container-platform/3.10:community_package/community/latest" for docs.openshift.com/container-platform/3.10 and docs.okd.io/latest
+if [[ ! -z "$DISALLOW_CRAWL_DIRS" ]]; then
+    echo "---> Creating robot.txt file for disallowing crawlers"
+    IFS=':'; directories=($DISALLOW_CRAWL_DIRS); unset IFS;
+    for dir in "${directories[@]}"; do
+        echo "--->     Creating robots.txt to prevent crawling dir $dir"
+        PACKAGE=$(echo $dir | cut -d / -f 1)
+        TYPE=$(echo $dir | cut -d / -f 2)
+        URL_DIR=$(echo $dir | cut -d / -f 3)
+        URL_VERSION=$(echo $dir | cut -d / -f 4)
+        touch $PACKAGE/$TYPE/robots.txt
+        echo -e "User-agent: *\nDisallow: /$URL_DIR/$URL_VERSION" >> $PACKAGE/$TYPE/robots.txt
+    done
+fi
+
+
 # Fix source directory permissions
 echo "---> Fixing permissions ..."
 fix-permissions ./