Documentation update #78
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation clarity for the SAP Testing Automation Framework and adds new configuration parameters for SAP high-availability instances.
- Updates preview status in README from “private” to “public”
- Enriches HIGH_AVAILABILITY.md with Azure Key Vault guidance, test report viewing steps, typo fixes, and corrects note syntax
- Introduces
scs_instance_numberanders_instance_numberinsap-parameters.yamlfor Central Services and ERS instance configuration
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Changed repository status note from “private preview” to “public preview” |
| docs/HIGH_AVAILABILITY.md | Added Azure Key Vault SSH/VM password instructions; fixed path typo; detailed HTML report viewing steps; corrected Markdown note syntax |
| WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00/sap-parameters.yaml | Added scs_instance_number and ers_instance_number parameters |
Comment on lines
+266
to
+267
| # If you've the SSHKEY or VMPASSWORD stored in the an Azure Key Vault as Secret: | ||
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. |
There was a problem hiding this comment.
Fix grammar and duplicate article: change to If you have the SSH key or VM password stored in an Azure Key Vault as a secret:
Suggested change
| # If you've the SSHKEY or VMPASSWORD stored in the an Azure Key Vault as Secret: | |
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. | |
| # If you have the SSH key or VM password stored in an Azure Key Vault as a secret: | |
| # - Enter the Azure Key Vault Resource ID in the key_vault_id parameter and the Secret ID in the secret_id parameter. |
Copilot uses AI. Check for mistakes.
Comment on lines
+266
to
+269
| # If you've the SSHKEY or VMPASSWORD stored in the an Azure Key Vault as Secret: | ||
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. | ||
| # - You can find the Resource ID of Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | ||
| # - You can find the Resource ID of Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secrete Identifier |
There was a problem hiding this comment.
Correct typos: Secrete → Secret and paramter → parameter.
Suggested change
| # If you've the SSHKEY or VMPASSWORD stored in the an Azure Key Vault as Secret: | |
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. | |
| # - You can find the Resource ID of Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | |
| # - You can find the Resource ID of Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secrete Identifier | |
| # If you've the SSHKEY or VMPASSWORD stored in an Azure Key Vault as a Secret: | |
| # - Enter the Azure Key Vault Resource ID in the key_vault_id parameter and the Secret ID in the secret_id parameter. | |
| # - You can find the Resource ID of the Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | |
| # - You can find the Resource ID of the Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secret Identifier |
Copilot uses AI. Check for mistakes.
Comment on lines
+267
to
+269
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. | ||
| # - You can find the Resource ID of Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | ||
| # - You can find the Resource ID of Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secrete Identifier |
There was a problem hiding this comment.
Fix typo: Secrete → Secret.
Suggested change
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secrete ID in secret_id paramter. | |
| # - You can find the Resource ID of Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | |
| # - You can find the Resource ID of Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secrete Identifier | |
| # - Enter the Azure Key Vault Resource ID in key_vault_id parameter and the Secret ID in secret_id paramter. | |
| # - You can find the Resource ID of Key Vault in Azure Portal → Key Vaults → Your Key Vault → JSON view → Copy the Resource ID | |
| # - You can find the Resource ID of Secret in Your Key Vault → Secrets → Select Secret → Current Version → Copy the Secret Identifier |
Copilot uses AI. Check for mistakes.
Comment on lines
11
to
+12
| scs_cluster_type: AFA | ||
| scs_instance_number: "00" |
There was a problem hiding this comment.
[nitpick] Add a brief comment describing scs_instance_number and ers_instance_number to explain their purpose (e.g., two-digit instance number for the SAP Central Services and Enqueue Replication Server).
Suggested change
| scs_cluster_type: AFA | |
| scs_instance_number: "00" | |
| scs_cluster_type: AFA | |
| # scs_instance_number is the two-digit instance number for the SAP Central Services (SCS) | |
| scs_instance_number: "00" | |
| # ers_instance_number is the two-digit instance number for the Enqueue Replication Server (ERS) |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes updates to documentation and configuration files for the SAP Testing Automation Framework. The changes improve clarity, provide additional usage instructions, and modify some configuration parameters.
Documentation Updates:
README.md: Updated the repository status from "private preview" to "public preview" to reflect its current state.docs/HIGH_AVAILABILITY.md: Added detailed instructions for using Azure Key Vault to store SSH keys or VM passwords, including how to locate the required resource and secret IDs.docs/HIGH_AVAILABILITY.md: Enhanced the "Viewing Test Results" section with step-by-step instructions to locate and interpret the generated HTML test report, including an example screenshot.docs/HIGH_AVAILABILITY.md: Corrected a minor typo in the file path for creating a password file (WORKSPACE→WORKSPACES).docs/HIGH_AVAILABILITY.md: Replaced the incorrect Markdown syntax for a note with the correct format.Configuration Updates:
WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00/sap-parameters.yaml: Addedscs_instance_numberanders_instance_numberparameters to specify instance numbers for the SAP Central Services and Enqueue Replication Server.