Aap test

.gitignore

@@ -1,14 +1,25 @@
+tmp
+*#
+*~
+.sw*
+.*.sw*
+master.html
+.DS_Store
+*/.DS_Store
+# Pycharm stuff
+.idea
+# VSCode stuff
+.vscode
+.vscode/
+# virtual environments
+venv
 #ignores output from ./scripts/buildGuides.sh
 
 #manually ignoring build dirs,
 #feel free to make this better with a regex
-
-*~
 build/
 html/
 .zanata-cache/
-.DS_Store
-*/.DS_Store
 *.zip
 emender/results/*
 downstream/titles/*/master.html

LICENSE.txt

@@ -0,0 +1,4 @@
+This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+International License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
+Commons, PO Box 1866, Mountain View, CA 94042, USA.

README.adoc

@@ -1,8 +1,14 @@
 # Red Hat Ansible Automation Platform Documentation
 
+Welcome to the source for Ansible Automation Platform technical content.
+
+This repository contains technical content synchronized from various repositories and then converted into asciidoc.
+
+This repository also contains content from the former AAP repository in the RedHatInsights org: https://github.com/RedHatInsights/red-hat-ansible-automation-platform-documentation
+
 ## Contributing
 
-We welcome contributions to the Red Hat Ansible Automation Platform documentation. You can either link:https://github.com/RedHatInsights/red-hat-ansible-automation-platform-documentation/issues[open an issue] for discussion, or submit an update using the steps below. This section describes the workflow and provides resources for Red Hat style and documentation architecture conventions.
+We welcome contributions to the Red Hat Ansible Automation Platform documentation. You can either link:https://github.com/ansible/aap-docs/issues[open an issue] for discussion, or submit an update using the steps below. This section describes the workflow and provides resources for Red Hat style and documentation architecture conventions.
 
 ### Authoring modularly structured documentation
 
@@ -14,15 +20,25 @@ Documentation follows a link:https://redhat-documentation.github.io/modular-docs
 ....
 .
 |
-├── common
 ├── downstream
+│   ├── aap-common
+│   │   ├── assembly-aap-common.adoc
+│   │   ├── external-site-disclaimer.adoc
+│   │   ├── making-open-source-more-inclusive.adoc
+│   │   └── providing-feedback.adoc
+│   ├── archive
+│   │   ├── archived-aap-common
+│   │   ├── archived-assemblies
+│   │   ├── archived-images
+│   │   ├── archived-modules
+│   │   └── archived-titles
 │   ├── assemblies
 │   │   ├── platform-component1
 │   │   └── platform-component2
-│   │        ├── assembly-title-1.adoc
-│   │        ├── assembly-title-2.adoc
-│   │        └── modules -> ../modules/
+│   │       ├── assembly-title-1.adoc
+│   │       └── assembly-title-2.adoc
 │   ├── attributes
+│   │   └── attributes.adoc
 │   ├── images
 │   │   ├── image-1.png
 │   │   └── image-2.png
@@ -31,32 +47,37 @@ Documentation follows a link:https://redhat-documentation.github.io/modular-docs
 │   │   └── platform-component2
 │   │       ├── module-title-1.adoc
 │   │       └── module-title-2.adoc
+|   ├── snippets
+|   ├── templates
 |   ├── titles
 │   │   ├── platform-component1
 │   │   └── platform-component2
 │   │        ├── title-1.adoc
-│   │        ├── title-2.adoc
-│   │        └── modules -> ../modules/
-├── release-notes
+│   │        └── title-2.adoc
+├── titles/release-notes-gcp
+├── LICENSE.txt
 └── README.adoc
+
 ....
 
-Top-level directories are:
-
-* `common`: Contains modules and attributes that are shared across Red Hat Ansible Automation branches.
-You should modify content in the `common` folder on the `main` branch only.
+The top-level directories are:
 
 * `downstream`: Contains Red Hat Ansible Automation Platform modules, assemblies, and titles in these sub-folders:
 
-** `attributes`: A common directory for attribute files.
+** `aap-common`: Contains modules and attributes that are shared across Red Hat Ansible Automation branches.
+You should modify content in the `common` folder on the `main` branch only.
+** `archive`: A directory for archived files and images.
 ** `assemblies`: A directory for all assemblies, each in its own AsciiDoc file.
 Assemblies are collections of modules linked together.
 Platform assemblies are grouped by component.
+** `attributes`: A common directory for attribute files.
 ** `images`: A directory for all images and other digital content.
 ** `modules`: A directory for all modules, each one in its own AsciiDoc file.
 Platform modules are grouped by component.
+** `snippets`: A directory for all snippets created.
+** `templates`: A directory for templates used by controller, hub, and operator. 
 ** `titles`: A directory for titles (information units, e.g, install guide, user guide).
-Contains `master.adoc` files that and symbolic links to the `assemblies` and `modules` directories.
+Contains `master.adoc` files and symbolic links to the `assemblies` and `modules` directories.
 Platform titles are grouped by component or feature.
 
 * `release-notes`: Contains release note content.
@@ -82,7 +103,7 @@ The first time you contribute:
 
 . Fork the repository.
 
-   From the main page of the link:https://github.com/RedHatInsights/red-hat-ansible-automation-platform-documentation[GitHub repository], click btn[Fork] in the upper right corner.
+   From the main page of the link:https://github.com/ansible/aap-docs[GitHub repository], click btn[Fork] in the upper right corner.
 
 . Clone the forked repository locally.
 
@@ -97,7 +118,7 @@ $ git clone [email protected]:<username>/red-hat-ansible-automation-platform-docume
 . Set the upstream remote repository.
 
  -----
- $ git remote add -f upstream [email protected]:RedHatInsights/red-hat-ansible-automation-platform-documentation.git
+ $ git remote add -f upstream [email protected]:ansible/aap-docs.git
  -----
 
 To submit an update:
@@ -108,10 +129,10 @@ To submit an update:
    $ git fetch upstream
    -----
 
-. Check out a branch from upstream/master
+. Check out a branch from upstream/main
 
 -----
-$ git checkout -b <new-branch> upstream/master
+$ git checkout -b <new-branch> upstream/main
 -----
 
 . Make your edits.
@@ -138,7 +159,7 @@ $ git push origin HEAD
 
 . Open a pull request.
 
-   Typically the previous command gives the URL to open a pull request. If not, you can open one from the link:https://github.com/RedHatInsights/red-hat-ansible-automation-platform-documentation/pulls[Pull requests] tab of the GitHub UI.
+   Typically the previous command gives the URL to open a pull request. If not, you can open one from the link:https://github.com/ansible/aap-docs/pulls[Pull requests] tab of the GitHub UI.
 
 After you submit a pull request, it will be reviewed by members of this project.
 

downstream/aap-common/boilerplate.adoc

@@ -0,0 +1,4 @@
+// Removing the following module from AAP docs front matter because the
+// docs.redhat.com site already includes a similar statement.
+// include::making-open-source-more-inclusive.adoc[leveloffset=+1]
+include::{DocumentationFeedback}[leveloffset=+1]

downstream/aap-common/providing-feedback.adoc

@@ -0,0 +1,7 @@
+[preface]
+:_module-type: CONCEPT
+[id="providing-feedback"]
+= Providing feedback on Red Hat documentation
+
+If you have a suggestion to improve this documentation, or find an error, please contact technical support at link:https://access.redhat.com[https://access.redhat.com] to create an issue on the {PlatformNameShort} Jira project using the *docs-product* component.
+

downstream/archive/archived-assemblies/catalog/assembly-installing-receptor.adoc

@@ -87,7 +87,7 @@ $ curl -O https://raw.githubusercontent.com/mkanoor/receptor_catalog_installer_s
 You can use the included `install.sh` to register your system through Red Hat Subscription Manager and install required versions of Ansible, Python, and the Ansible Role.
 
 .Prerequisites
-The `install.sh` script requires a valid Red Hat username and password. See https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/[Red Hat Subscription Management] documentation for more information on registering a system.
+The `install.sh` script requires a valid Red Hat username and password. See {BaseURL}/red_hat_subscription_management/1/[Red Hat Subscription Management] documentation for more information on registering a system.
 
 [NOTE]
 ====

downstream/archive/archived-assemblies/hub/assembly-uploading-content-to-automation-hub.adoc

@@ -6,8 +6,8 @@ Red Hat Automation Hub distributes certified, supported collections from partner
 You can upload collections using the Automation Hub user interface or the `ansible-galaxy` client.
 
 .Prerequisites
-* You are a Red Hat Connect Partner. Learn more at https://connect.redhat.com/[Red Hat Partner Connect].
+* You are a Red Hat Connect Partner. Learn more at link:https://connect.redhat.com/[Red Hat Partner Connect].
 
-include::automation-hub/proc-upload-collection.adoc[leveloffset=+1]
+include::hub/proc-upload-collection.adoc[leveloffset=+1]
 
 Once uploaded, your collections will enter the partner certification process. Our Partner Engineering team will contact you with the certification status of your collection.

downstream/archive/archived-assemblies/platform/assembly-installing-controller-operator-external-db.adoc

@@ -35,7 +35,7 @@ include::platform/proc-controller-ingress-options.adoc[leveloffset=+2]
 [role="_additional-resources"]
 == Additional resources
 
-* For more information on running operators on OpenShift Container Platform, navigate to the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide.
+* For more information on running operators on OpenShift Container Platform, navigate to the link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide.
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

downstream/archive/archived-assemblies/platform/assembly-installing-controller-operator-local-db.adoc

@@ -56,7 +56,7 @@ include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=2]
 [role="_additional-resources"]
 == Additional resources
 
-* See link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.2/html/operators/index[Working with Operators in OpenShift Container Platform] for more information on running operators on OpenShift Container Platform.
+* See link:{BaseURL}/openshift_container_platform/4.2/html/operators/index[Working with Operators in OpenShift Container Platform] for more information on running operators on OpenShift Container Platform.
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

downstream/archive/archived-assemblies/platform/assembly-installing-hub-operator-external-db.adoc

@@ -34,7 +34,7 @@ include::platform/proc-access-hub-operator-ui.adoc[leveloffset=+1]
 [role="_additional-resources"]
 == Additional resources
 
-* For more information on running operators on OpenShift Container Platform, navigate to the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide.
+* For more information on running operators on OpenShift Container Platform, navigate to the link:{BaseURL}/openshift_container_platform/[OpenShift Container Platform product documentation] and click the _Operators - Working with Operators in OpenShift Container Platform_ guide.
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

downstream/archive/archived-assemblies/platform/assembly-installing-hub-operator-local-db.adoc

@@ -89,7 +89,7 @@ If you did not specify an administrator password during configuration, one was a
 [role="_additional-resources"]
 == Additional resources
 
-* See link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.2/html/operators/index[Working with Operators in OpenShift Container Platform] for more information on running operators on OpenShift Container Platform.
+* See link:{BaseURL}/openshift_container_platform/4.2/html/operators/index[Working with Operators in OpenShift Container Platform] for more information on running operators on OpenShift Container Platform.
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

downstream/archive/archived-assemblies/platform/assembly-upgrading-controller.adoc

@@ -31,7 +31,7 @@ If {PlatformName} is on a version of RHEL older than RHEL 8 and you want to upgr
 
 This process ensures that the PostgreSQL database is also properly migrated to the latest version if you are upgrading an embedded-database Tower. Depending on the size of your |aap| installation, this may take some time. Note that if you upgrade a Tower with an external database, the client libraries will be upgraded as well, but you will need to upgrade your external PostgreSQL server manually. Be sure the check the release notes to see if this applies to you before upgrading.
 
-If the upgrade of Tower fails or if you need assistance, please contact Ansible via the Red Hat Customer portal at https://access.redhat.com/.
+If the upgrade of Tower fails or if you need assistance, please contact Ansible via the https://access.redhat.com/[Red Hat Customer portal].
 
 == Requirements
 

downstream/modules/automation-hub/con-namespaces.adoc → downstream/archive/archived-modules/con-namespaces.adoc

@@ -8,10 +8,3 @@
 
 Namespaces are unique locations in {HubName} to which you can upload and publish content collections. Access to namespaces in {HubName} is governed by groups with permission to manage the content and related information that appears there.
 
-.Formatting collections for your namespaces
-
-You can upload internally developed collections to {HubName} in `tar.gz` file format that meet the following name convention:
-
------
-<my_namespace-my_collection-1.0.0.tar.gz>
------

downstream/archive/archived-modules/platform/ref-network-ports-protocols.adoc

@@ -5,12 +5,12 @@
 
 [role="_abstract"]
 
-{PlatformName} (AAP) uses a number of ports to communicate with its services. These ports must be open and available for incoming connection to the {PlatformName} server in order for it to work. Ensure that these ports are available and are not being blocked by the server firewall.
+{PlatformName} uses several ports to communicate with its services. These ports must be open and available for incoming connections to the {PlatformName} server in order for it to work. Ensure that these ports are available and are not being blocked by the server firewall.
 
-The following tables provide the default {PlatformName} destination ports required for each application.
+The following tables show the default {PlatformName} destination ports required for each application.
 
 [NOTE]
-The default destination ports and installer inventory listed below are configurable. If you choose to configure them to suit your environment, you may experience a change in behavior.
+The following default destination ports and installer inventory listed are configurable. If you choose to configure them to suit your environment, you might experience a change in behavior.
 
 
 
@@ -73,7 +73,7 @@ Hybrid mode in a cluster
 |Receptor
 |Inbound and Outbound
 |`receptor_listener_port`
-|ALLOW receptor listener port across all controllers for mandatory & automatic control plane clustering
+|ALLOW receptor listener port across all controllers for mandatory and automatic control plane clustering
 |===
 
 .Hop Nodes
@@ -136,7 +136,7 @@ ALLOW connections from hop node(s) to Receptor port (if relayed through hop node
 |Receptor
 |Inbound and Outbound
 |`receptor_listener_port`
-a|Mesh - Nodes directly peered to controllers. Direct nodes involved. 27199 is bi-diretional for execution nodes
+a|Mesh - Nodes directly peered to controllers. Direct nodes involved. 27199 is bi-directional for execution nodes
 
 ENABLE connections from controller(s) to Receptor port for non-hop connected nodes
 
@@ -252,7 +252,7 @@ a|Open *only* if the internal database is used. Otherwise, this port should not
 |link:https://sso.redhat.com:443[https://sso.redhat.com:443] |TCP
 |link:https://automation-hub-prd.s3.amazonaws.com[https://automation-hub-prd.s3.amazonaws.com] |
 |link:https://galaxy.ansible.com[https://galaxy.ansible.com] |Ansible Community curated Ansible content
-|link:https://ansible-galaxy.s3.amazonaws.com[https://ansible-galaxy.s3.amazonaws.com] |
+|link:https://ansible-galaxy-ng.s3.dualstack.us-east-1.amazonaws.com[https://ansible-galaxy-ng.s3.dualstack.us-east-1.amazonaws.com] |
 |link:https://registry.redhat.io:44[https://registry.redhat.io:443] |Access to container images provided by Red Hat and partners
 |link:https://cert.cloud.redhat.com:443[https://cert.cloud.redhat.com:443] |Red Hat and partner curated Ansible Collections
 |===

downstream/archive/archived-titles/hub/configuring-galaxy-cli/master.adoc

@@ -12,4 +12,4 @@ Optionally, you can configure Ansible Galaxy as a secondary source of content.
 include::aap-common/making-open-source-more-inclusive.adoc[leveloffset=+1]
 include::aap-common/providing-direct-documentation-feedback.adoc[leveloffset=+1]
 
-include::automation-hub/proc-configure-automation-hub-server-cli.adoc[leveloffset=+1]
+include::hub/proc-configure-automation-hub-server-cli.adoc[leveloffset=+1]

downstream/titles/hub/configuring-private-hub-rh-certified/docinfo.xml → downstream/archive/archived-titles/hub/configuring-private-hub-rh-certified/docinfo.xml

@@ -1,6 +1,6 @@
 <title>Managing Red Hat Certified, validated, and Ansible Galaxy content in automation hub</title>
 <productname>Red Hat Ansible Automation Platform</productname>
-<productnumber>2.4</productnumber>
+<productnumber>2.5</productnumber>
 <subtitle>Configure and distribute curated collections with automation hub</subtitle>
 <abstract>
 <para>This guide shows how to configure automation hub to deliver curated Red Hat Certified and Ansible Galaxy collections to your users.</para>

downstream/titles/hub/high-availability/docinfo.xml → downstream/archive/archived-titles/hub/high-availability/docinfo.xml

@@ -1,6 +1,6 @@
 <title>Deploying a high availability automation hub</title>
 <productname>Red Hat Ansible Automation Platform</productname>
-<productnumber>2.4</productnumber>
+<productnumber>2.5</productnumber>
 <subtitle>Increase reliability and scalablility with a high availability deployment of automation hub</subtitle>
 <abstract>
 <para>This guide provides an overview of the requirements and procedures for a high availability deployment of automation hub.</para>

downstream/titles/hub/install/docinfo.xml → downstream/archive/archived-titles/hub/install/docinfo.xml

@@ -1,6 +1,6 @@
 <title>Installing and upgrading private automation hub</title>
 <productname>Red Hat Ansible Automation Platform</productname>
-<productnumber>2.4</productnumber>
+<productnumber>2.5</productnumber>
 <subtitle>Install or upgrade your private automation hub</subtitle>
 <abstract>
 <para>This guide provides the procedures required to install an instance of private automation hub or upgrade to a new version on online or offline Red Hat Enterprise Linux 8.4 and 9 physical or virtual machines.</para>

downstream/titles/hub/install/master.adoc → downstream/archive/archived-titles/hub/install/master.adoc

@@ -164,8 +164,8 @@ When the installation completes, you can verify your {PrivateHubName} has been i
 
 Your {PrivateHubName} is now ready for initial configuration. See the following administration guides for more:
 
-* https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.3/html/managing_user_access_in_private_automation_hub/index[Managing user access in Private Automation Hub]
-* https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.3/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/index[Managing Red Hat Certified and Ansible Galaxy collections in Automation Hub]
+* {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/managing_user_access_in_private_automation_hub/index[Managing user access in Private Automation Hub]
+* {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/index[Managing Red Hat Certified and Ansible Galaxy collections in Automation Hub]
 
 == Upgrading to the latest version
 

downstream/titles/hub/lifecycle/docinfo.xml → downstream/archive/archived-titles/hub/lifecycle/docinfo.xml

@@ -1,6 +1,6 @@
 <title>Private Automation Hub life cycle</title>
 <productname>Red Hat Ansible Automation Platform</productname>
-<productnumber>2.4</productnumber>
+<productnumber>2.5</productnumber>
 <subtitle>Maintenance and updates statement for automation hub</subtitle>
 <abstract>
     <para>This guide describes the maintenance schedule for security patches and feature enhancements that Red Hat will provide for the Private Automation Hub.</para>