Bfg

.github/workflows/cherry-pick.yml

@@ -0,0 +1,36 @@
+name: Cherry Pick
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  cherry-pick:
+    runs-on: ubuntu-latest
+    if: |
+      startsWith(github.event.comment.body, '/cherry-pick')
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Git
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+      - name: Extract target branch
+        id: extract
+        run: echo "::set-output name=branch::$(echo "${{ github.event.comment.body }}" | cut -d' ' -f2)"
+
+      - name: Cherry-pick the PR
+        env:
+          GH_PAT: ${{ secrets.GH_PAT }}
+        run: |
+          TARGET_BRANCH=${{ steps.extract.outputs.branch }}
+          git fetch origin ${{ github.event.pull_request.head.ref }}
+          git checkout $TARGET_BRANCH
+          git cherry-pick ${{ github.event.pull_request.head.sha }} || exit 0
+      - name: Push changes
+        env:
+          GH_PAT: ${{ secrets.GH_PAT }}
+        run: |
+          git push https://${GH_PAT}@github.com/${{ github.repository }} $TARGET_BRANCH

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v4
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: pip install mkdocs-swagger-ui-tag
+      - run: pip install "mkdocs-material[imaging]"
+      - run: mkdocs gh-deploy --force

.gitleaks.toml

@@ -0,0 +1,54 @@
+[allowlist]
+description = "Allow bcrypt hashes used in SQL updates"
+
+regexes = [
+  # Ignore bcrypt password hashes (e.g., $2b$12$...)
+  '''\$2b\$12\$[A-Za-z0-9./]{53}'''
+]
+
+paths = [
+  # Ignore all example certs
+  '''\/example.*\.pem$''',
+
+  # Ignore anything with the word funkymonkey anywhere in the path (example values below)
+  '''ANSWCWSGLVAUQ60L4Q4CEO3C1QAYGEXZK2VKJNI''',
+  '''E6GJSHOZMFBVNHTHNB53''',
+  '''MCJ61D8KQBFS2DXM56S2''',
+  '''J5G7CCX5QCA8Q5XZLWGI7USJPSM4M5MQHJED46CF''',
+  '''IG58PX2REEY9O08IZFZE''',
+  '''2LWTWO89KH26P2CO4TWFM7PGCX4V4SUZES2CIZMR''',
+  '''6XBK7QY7ACSCN5XBM3GS''',
+  '''AVKBOUXTFO3MXBBK5UJD5QCQRN2FWL3O0XPZZT78''',
+  '''SANSWCWSGLVAUQ60L4Q4CEO3C1QAYGEXZK2VKJNI''',
+  '''WB4FUG4PP2278KK579EN4NDP150CPYOG6DN42MP6JF8IAJ4PON4RC7DIOH5UEFBP''',
+  '''MXFE7NSOWPN33O7UC3THY0BN03DW940CMWTLRBE2EPTI8JPX0B0CWIIDGTI4YTJ6''',
+  '''IJWZ8TIY301KPFOW3WEUJEVZ3JR11CY1''',
+  '''9Q36xF54YEOLjetayC0NBaIKgcFFmIHsS3xTZDLzZSrhTBkxUc9FDwUKfnxLWhco6oBJV1NDBjoBcDGmsZMYPt1dSA4yWpPe/JKY9pnDcsw=''', 
+  '''MXZ9DATUWRD8WCMT8AZIPYE0IEZHJJ1B8P8ZEIXC0W552DUMMTNJJH02HFGXTOVG''',
+  '''CWLBVAODE61IXNDJ40GERFOZPB3ARZDRCP4X70ID1NB28AI0OOJBTR9S4M0ACYMD''',
+  '''BILZ6YTVAZAKOGMD9270OKN3SOD9KPB7OLKEJQOJE38NBBRUJTIH7T5859DJL31Q''',
+  '''QBFYWIWZOS1I0P0R9N1JRNP1UZAOPUIR3EB4ASPZKK9IA1SFC12LTEF7OJHB05Z8''',
+  '''E6GJSHOZMFBVNHTHNB53''',
+  '''postgresql://<username>:test123@172.24.10.50/quay''',
+  '''postgresql://<username>:test123@172.24.10.50/example-restore-registry-quay-database''',
+  '''quayadmin''',
+  '''DB_URI: postgresql://restore-registry-quay-database:zLTm315muk6rz7mL4aFuLQ2Q8rAk-dB4kPHQ2WMvdyqhaZywf20503wCZfv2Ml1f15LUsDN2-0m71gnI@restore-registry-quay-database:5432/restore-registry-quay-database
+''',
+  '''DB_URI: postgresql://quay360-quay-database:0vrsIUYdhCnF8r-jwz7zR6gck6kcLLQhJ11u0dx1lz8YBk185P5NnqIBwtY22JArYLi3opdKJH2-w4aM@quay360-quay-database:5432/quay360-quay-database
+''',
+  '''XyThQKm6lMWh4O7dKdmRwMUHB9ktxPPVSRIePOY2''',
+  '''VvoFhVFp8BqcOgQ9LczE''',
+  '''DB_URI: postgresql://restore-registry-quay-database:zLTm315muk6rz7mL4aFuLQ2Q8rAk-dB4kPHQ2WMvdyqhaZywf20503wCZfv2Ml1f15LUsDN2-0m71gnI@restore-registry-quay-database:5432/restore-registry-quay-database
+''',
+  '''postgresql://quayuser:quaypass@quay-server:5432/quay''',
+  '''4b1c5663-88c6-47ac-b4a8-bb594660f08b''',
+  '''postgresql://example-registry-quay-database:OyC4zGhJMbi3yUzW1aIgOLQNW18r14nAcuJfbsjtrAXUVInj2JgwLskQPOutPCXMtlKr1UPTsIPqOEjV@example-registry-quay-database:5432/example-registry-quay-database''',
+  '''postgresql://restore-registry-quay-database:zLTm315muk6rz7mL4aFuLQ2Q8rAk-dB4kPHQ2WMvdyqhaZywf20503wCZfv2Ml1f15LUsDN2-0m71gnI@restore-registry-quay-database:5432/restore-registry-quay-database''',
+  '''postgresql://example-restore-registry-quay-database:onHl1LDsspZh4hoOL5wW1Of7GV0Kmtp2@example-restore-registry-quay-database:5432/example-restore-registry-quay-database''',
+  '''postgresql://example-restore-registry-quay-database:onHl1LDsspZh4hoOL5wW1Of7GV0Kmtp2@example-restore-registry-quay-database:5432/example-restore-registry-quay-database''',
+  '''zsk/j4zEOkQq+W0BQJdSufP+IackV8WICXB5zvdF''',
+  '''1H36Izzc90cUNVHaiaUX''',
+  '''iO1b3RUt4KKgjSimCROSPN3cEMn4TqSgsPyniMBR''',
+  '''EH67NB3Y6PTBED8H0HC6UVHGGGA3ODSE''',
+  '''fn37AZAUQH0PTsU+vlO9lS0QxPW9A/boXL4ovZjIFtlUPrBz9i4j9UDOqMjuxQ/0HTfy38goKEpG8zYXVeQh3lOFzuOjSvKic2Vq7xdtQsU=''',
+]

.vale.ini

@@ -0,0 +1,8 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+
+Packages = RedHat
+
+[*]
+BasedOnStyles = RedHat

.vale/styles/Vocab/OpenShiftDocs/accept.txt

@@ -0,0 +1,11 @@
+# Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
+# Add terms that have a corresponding incorrectly capitalized form to reject.txt.
+
+[Pp]assthrough
+Assisted Installer
+Control Plane Machine Set Operator
+custom resource
+custom resources
+MetalLB
+Operator
+Operators

.vale/styles/Vocab/OpenShiftDocs/reject.txt

@@ -0,0 +1,15 @@
+# Regex terms added to reject.txt are highlighted as errors by the Vale linter and override RedHat Vale rules.
+# Add terms that have a corresponding correctly capitalized form to accept.txt.
+
+[Dd]eployment [Cc]onfigs?
+[Dd]eployment [Cc]onfigurations?
+[Oo]peratorize
+[Ss]ingle [Nn]ode OpenShift
+[Tt]hree [Nn]ode OpenShift
+AI
+configuration maps?
+MachineSets
+machinesets?
+minions?
+operators?
+SNO

.vscode/settings.json

@@ -4,5 +4,9 @@
         "markdown",
         "latex",
         "plaintext"
+    ],
+    "cSpell.words": [
+        "OIDC",
+        "productname"
     ]
 }

README.adoc

@@ -1,33 +1,35 @@
-= Documentation for the {productname} product
+= Contributing to Red Hat Quay documentation
 :downstream:
 
 == Repository structure
 
-Structure of this repository:
+The Red Hat Quay repository is structured as follows:
 
-* Books go into a top-level directory. For example: `repo_dir/manage_quay/`.
-* Each book directory has a symlink to the top-level `repo_dir/modules/` directory.
-* A book's TOC is defined in the `master.adoc` file contained within the book's directory.
-* `master.adoc` contains `include` statements to modules (chapters), which are created in the top-level `modules/` directory.
-* `docinfo.xml` in the book's directory contains basic information about the book.
+* Books go into a top-level directory. For example, `repo_dir/manage_quay` or `repo_dir/release_notes`. 
+* Each book directory has a symlink to the top-level `repo_dir/modules` directory. 
+* A book's _table of contents_, or ToC, is defined in the `master.adoc` that is contained within the book's directory. Each directory has its own `master.adoc` file. 
+* The `master.adoc` file contains `include` statements to _modules_, which act as chapters and subchapters. These are created in the top-level `modules/` directory. 
+* The `docinfo.xml` in the book's directory contains basic information about the book, such as the product name, the product version, and the organization name. 
 
-== How do I set up?
+== Setting up your repository for contribution
 
 ifdef::downstream[]
 
-. Get the _Developer_, the _Maintainer_, or the _Owner_ permissions for the https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/[downstream repository]. For that, contact a Maintainer or an Owner from this https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/-/project_members[list]. Default to contacting Vikram Goyal.
+. For _downstream_ contribution, which is the official Red Hat Quay documentation found on the Red Hat portal, you must obtain _Developer_, _Maintainer_, or _Owner_ permissions for the https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/[downstream repository].
++
+To obtain the necessary permissions, contact a Maintainer or Owner from the Gitlab project members https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/-/project_members[list]. Default to contacting Steven Smith.
 
 endif::downstream[]
 
-. Fork the  https://github.com/quay/quay-docs[upstream repository] by clicking "Fork".
+. Fork the  https://github.com/quay/quay-docs[upstream repository] by clicking the *Fork* button.
 
 . Clone your fork of the repository to your computer:
 +
 ----
-$ git clone git@github.com:<USERNAME>/quay-docs.git
+$ git clone git@github.com:<username>/quay-docs.git
 ----
 +
-Substitute <USERNAME> with your GitHub user name.
+Substitute `<username>` with your GitHub user name.
 
 . Navigate to the cloned repository:
 +
@@ -54,53 +56,65 @@ endif::downstream[]
 [id="how-do-i-make-a-contribution"]
 == How do I make a contribution?
 
-. Create a new <branch-name> branch based off the `3.0-master` branch and switch to it:
+To contribute to Red Hat Quay documentation, you must create a new feature branch based off of the `master` branch.
+
+. Checkout the `master` branch if you have not already:
 +
 ----
-$ git checkout -b <branch_name> 3.0-master
+$ git checkout master
 ----
+
+. Create a new feature branch based off the `master` branch:
 +
-Substitute <branch_name> with a name that reflects the contribution you intend to make.
+----
+$ git checkout -b <branch_name> master
+----
++
+Substitute `<branch_name>` with a name that reflects the contribution you intend to make.
 
-. Edit the files and commit them using `git add` and `git commit`.
+. Edit the files and commit them using `git add` and `git commit`. Make your commit in present tense, highlighting the change that you have made.
 
 . Push your commits to your fork of the upstream repository:
 +
 ----
 $ git push origin <branch_name>
 ----
 
-. Create a pull request from `<your_fork>/<branch_name>` to `quay/3.0-master`. For that, either:
+. Create a pull request from `<your_fork>/<branch_name>` to `quay/master`. For that, either:
 +
 --
-.. visit the link from the output of the previous step (the link is there after the first push only)
-.. navigate to https://github.com/<YOUR_USERNAME>/quay-docs and use the interface to create the pull request
+.. Visit the link from the output of the previous step. The link is there after the first push only.
+
+.. Navigate to https://github.com/<your_username>/quay-docs. Use the interface to create the pull request
 --
 +
-As you create the pull request, tag one of the repository collaborators and ask them to review the pull request.
+As you create the pull request, tag one of the repository collaborators and ask them to review the pull request. The default contact should be Steven Smith.
 
-. Work together with the reviewer to finish your pull request, then ask them to merge it.
+. Work with the reviewer to finish your pull request. After the suggested changes have been made, the reviewer will merge the pull request.
 
-. Shortly after your pull request is merged into the `3.0-master` branch, your updates will become live in the https://docs.projectquay.io[Project Quay documentation].
+. After your pull request is merged into the `master` branch, your updates will become live in the https://docs.projectquay.io[Project Quay documentation]. Eventually, those changes will end up on the portal. 
 
 == How do I make a contribution to the downstream documentation?
 
-Downstream documentation resides in the `3.0-stage` branch of the https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/[downstream repository]. However, Quay documentation is upstream-first. This means that all changes, including downstream-only content, first go to the `3.0-master` branch of the https://github.com/quay/quay-docs[upstream repository]. After that, they are pushed to the `3.0-master` branch of the downstream repository and get merged to the `3.0-stage` branch.
+Like upstream documentation, downstream documentation primarily resides in the `master` branch of the https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/[downstream repository]. For most users, the only necessary step is to create a feature branch from the `master` branch.
 
-In other words, to contribute to the downstream documentation:
+To make a contribution to upstream documentation, follow the instructions at <<how-do-i-make-a-contribution>>. Be sure to work with the documentation lead for Red Hat Quay to get the content reviewed, merged, and published on the downstream portal. 
 
-. Make your contribution in the upstream: <<how-do-i-make-a-contribution>>
-. Move it over to the downstream repository: <<how-do-i-keep-the-downstream-repository-and-branch-up-to-date>>
+=== How Red Hat Quay downstream documentation is branched
 
-[id="how-do-i-keep-my-local-3.0-master-up-to-date-with-remote-3.0-master"]
-== How do I keep my local `3.0-master` up-to-date with remote `3.0-master`?
+After you have created and merged a pull request, relevant branches are then reset to match the `master` branch. For example, if the current version of Red Hat Quay is 3.10, then the relevant 3.10 branch (`redhat-3.10`) is reset to match the `master`. branch. This ensures that the most recent content changes are up to date in the most recent version branch. 
 
-As other people push to the `3.0-master` branch in the https://github.com/quay/quay-docs[upstream repository], you need to keep your local `3.0-master` up-to-date. It is optimal to do it regularly, for example, daily.
+After the the most recent branch is reset to match the `master` branch, the `3.0-stage` branch is then reset to match the most recent version branch (for example, `3.0-stage` is reset to match `redhat-3.10`). The reason for this is that the Red Hat Quay `3` version is copied directly from the most recent version of Red Hat Quay. 
 
-. Switch to `3.0-master`:
+[id="how-do-i-keep-my-local-master-up-to-date-with-remote-master"]
+== How do I keep my local `master` up-to-date with remote `master`?
+
+As contributors push and merge pull requests to the `master` branch, you must keep your local `master` branch up to date. Prior to making any changes to the documentation, you should rebase your local `master` branch to match the most recent version of the remote `master` branch. 
+
+. Check out the `master` branch:
 +
 ----
-$ git checkout 3.0-master
+$ git checkout master
 ----
 
 . Fetch the commits that are in the upstream repository but not in your local repository:
@@ -109,36 +123,38 @@ $ git checkout 3.0-master
 $ git fetch upstream
 ----
 
-. Apply the fetched commits to your local `3.0-master`:
+. Apply the fetched commits to your local `master`:
 +
 ----
-$ git rebase upstream/3.0-master
+$ git rebase upstream/master
 ----
 
-== How do I keep my feature branch up-to-date with 3.0-master?
+Now, your local `master` branch is up to date.
 
-As new commits appear on the `3.0-master` branch, your existing feature branch does not automatically incorporate those commits. To prevent your feature branch and `3.0-master` from diverging, you need to manually update your feature branch to `3.0-master`:
+== How do I keep my feature branch up-to-date with the master branch?
 
-. Bring your local `3.0-master` up-to-date with the remote `3.0-master`. <<how-do-i-keep-my-local-3.0-master-up-to-date-with-remote-3.0-master>>
+As new commits appear on the `master` branch, your existing feature branch does not automatically incorporate those commits. To prevent your feature branch and `master` from diverging, you need to manually update your feature branch to the `master` branch:
+
+. Bring your local `master` brnach up-to-date with the remote `master` branch by following the instructions at <<how-do-i-keep-my-local-master-up-to-date-with-remote-master>>.
 
 . Switch to the feature branch that you want to update:
 +
 ----
 $ git checkout <feature_branch>
 ----
 
-. Apply the commits from `3.0-master` to <feature_branch>:
+. Apply the commits from the `master` branch to your `<feature_branch>`:
 +
 ----
-$ git rebase upstream/3.0-master
+$ git rebase upstream/master
 ----
 +
 
-. Push the updated <feature_branch> to your fork of the upstream repository. Since your local <feature_branch> has been updated, it might be incompatible with the remote <feature_branch>, so you need to use the `--force` option:
+. Push the updated `<feature_branch>` to your fork of the upstream repository. Since your local `<feature_branch>` has been updated, it might be incompatible with the remote `<feature_branch>`, so you need to use the `--force` option:
 +
 [IMPORTANT]
 ====
-Never use the `--force` argument when pushing to `3.0-master`.
+Never use the `--force` argument when pushing to `master`.
 ====
 +
 ----
@@ -147,6 +163,7 @@ $ git push --force origin <feature_branch>
 
 ifdef::downstream[]
 
+////
 [id="how-do-i-keep-the-downstream-repository-and-branch-up-to-date"]
 == How do I keep the downstream repository and branch up-to-date?
 
@@ -185,13 +202,12 @@ $ git push downstream
 ----
 
 endif::downstream[]
+////
 
 == How do I make content appear in upstream but not in downstream?
 
-If you need to make a part of content appear only https://docs.projectquay.io[in the upstream documentation]:
+You can make content appear only in the upstream by using the `ifdef::upstream` conditional around the content that you only want to appear upstream. For example: 
 
-* Surround the content with these lines:
-+
 ----
 \ifdef::upstream[]
 <Content that should be in upstream only.>
@@ -201,10 +217,8 @@ If you need to make a part of content appear only https://docs.projectquay.io[in
 ifdef::downstream[]
 == How do I make content appear in downstream but not in upstream?
 
-If you need to make a part of content appear only https://access.redhat.com/documentation/en-us/red_hat_quay/3/[in the downstream documentation]:
+You can make content appear only in the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/[downstream] by using the `ifdef::downstream` conditional around the content that you only want to appear downstream. For example: 
 
-* Surround the content with these lines:
-+
 ----
 \ifdef::downstream[]
 <Content that should be in downstream only.>

access_permissions_management/docinfo.xml

@@ -0,0 +1,10 @@
+<productname>{productname}</productname>
+<productnumber>{producty}</productnumber>
+<subtitle>Managing access and permissions</subtitle>
+<abstract>
+    <para>Managing access and permissions: Roles, Robots, and Repository Security</para>
+</abstract>
+<authorgroup>
+    <orgname>Red Hat OpenShift Documentation Team</orgname>
+</authorgroup>
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />