Merge pull request #4449 from EnterpriseDB/release/2023-07-17

Release: 2023-07-17

install_template/README.md

@@ -225,3 +225,44 @@ In a handful of situations it is useful to employ conditionals to include or mod
 Be wary of over-using these; prefer inheritance structures that push this content down to sufficiently-specific "leaf" templates instead. As a general rule, use conditionals only when the test is much, much simpler than the alternative inheritance structure, and be willing to abandon it when (over time) that simplicity is lost.
 
 In particular, avoid the trap of setting a flag in a leaf template and then checking it in a base template: this separates the context from the decision, making it extremely difficult to judge when the test has lost its value.
+
+#### Adding a new platform
+
+1. Modify **config.yaml**. For example, when adding the RHEL 9 platform, the following entries were made to each product:
+
+- name: RHEL 9
+  arch: ppc64le
+  supported versions: [<supported_versions>]
+- name: AlmaLinux 9 or Rocky Linux 9
+   arch: x86_64
+   supported versions: [<supported_versions>]
+- name: RHEL 9 or OL 9
+   arch: x86_64
+   supported versions: [<supported_versions>]
+   
+1. In **templates/platformBase_deploymentConstants.njk**, update the `map_platform` and `map_platform_old` blocks. For example, for RHEL 9, the following lines were added to both blocks of code:
+
+"AlmaLinux 9 or Rocky Linux 9": "other_linux9",
+.
+.
+.
+"RHEL 9 or OL 9": "rhel9",
+"RHEL 9": "rhel9",
+
+1. In the **templates/platformBase** folder, copy existing topics, such as **rhel-8-or-ol-8.njk**, and use the copied files to create new versions. 
+   - Update the name to the next version, such as **rhel-9-or-ol-9.njk**. 
+   - Update content as necessary. For example, the file may include a reference to "latest-8.noarch.rpm", which should be updated to "latest-9.noarch.rpm". 
+   -The number of topics that need to be updated will vary depending on the platform being added. For RHEL 9, two new topics were created: **rhel-9-or-ol-9.njk** and **almalinux-9-or-rocky-linux-9.njk**.
+
+1. Update **templates/platformBase/ppc64le_index.njk** to add an entry in the navigation block in the front matter. For example, for RHEL 9, this entry was added:
+   - {{productShortname}}_rhel_9
+
+1. Update **templates/platformBase/x86_64_index.njk** to add entires in the navigation block in the front matter. For example, for RHEL 9, these entries were added:
+   - {{productShortname}}_rhel_9
+   - {{productShortname}}_other_linux_9
+
+1. In the **templates/products** folder, for each product, copy existing topics, such as **rhel-8-or-ol-8.njk**, and use the copied file create a new version. 
+   - Update the name to the next version, such as **rhel-9-or-ol-9.njk**. 
+   - In each file, update the entry for `platformBaseTemplate` so it points to the appropriate template, either in the **templates/platformBase** folder or in the current **templates/products** folder. 
+   - Check content to determine if other references require updating. 
+   - The number of topics that need to be updated will vary depending on the platform being added. For RHEL 9, two new topics were created: **rhel-9-or-ol-9.njk** and **almalinux-9-or-rocky-linux-9.njk**.