Documentation and Setup Improvements

[devanshjainms]

This pull request introduces significant improvements to documentation and project onboarding for the SAP Testing Automation Framework. The main changes include the addition of a comprehensive Copilot instructions file, a refactor of the high availability documentation to streamline setup guidance, and the creation of a dedicated setup guide. There are also minor corrections to file paths and naming for clarity.

Documentation and Onboarding Improvements

• Added a new .github/copilot-instructions.md file that provides detailed project context, coding partnership rules, enterprise-grade defaults, and specific guidance for contributors, ensuring clarity and consistency for new developers and Copilot usage.

• Refactored docs/HIGH_AVAILABILITY.md to remove technical requirements and setup instructions, replacing them with a reference to the new setup guide for a more maintainable and streamlined onboarding process. [1] [2]

• Created a new docs/SETUP.MD file with expanded technical requirements, step-by-step environment setup instructions, and details on Azure RBAC, network connectivity, and analytics integration, consolidating all onboarding information in one place.

File Structure and Path Corrections

• Renamed docs/DB_HIGH_AVAILABILITY.md to docs/high_availability/DB_HIGH_AVAILABILITY.md and corrected relative links to Ansible task files for improved clarity and navigation.

[Copilot]

Pull Request Overview

This pull request introduces significant improvements to documentation and project onboarding, along with major refactoring of the HA cluster validation system. The key changes modernize the constants structure, implement a new validation approach, and enhance the overall developer experience.

• Refactored HA validation logic from CIB-first to constants-first approach with tuple-based expected values
• Added comprehensive project documentation including Copilot instructions and dedicated setup guide
• Updated constants structure to include required/optional parameter flags for better validation control

Reviewed Changes

Copilot reviewed 18 out of 33 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/modules/get_pcmk_properties_scs_test.py	Updated test constants and assertions to match new tuple-based validation format
tests/modules/get_pcmk_properties_db_test.py	Modified test data structure and expectations for new validation system
tests/module_utils/get_pcmk_properties_test.py	Aligned test methods with refactored parameter status determination logic
src/vars/input-api.yaml	Enabled offline validation tests for both SCS and DB components
src/templates/report.html	Updated warning color scheme from yellow to orange for better visibility
src/roles/ha_scs/tasks/files/constants.yaml	Restructured configuration constants with value/required flags
src/roles/ha_db_hana/tasks/files/constants.yaml	Applied new constants structure with explicit required parameter definitions
src/modules/get_pcmk_properties_scs.py	Implemented new validation logic and offline validation support
src/modules/get_pcmk_properties_db.py	Added constants-first validation with HANA-specific logic
src/module_utils/sap_automation_qa.py	Removed unused Optional import
src/module_utils/get_pcmk_properties.py	Major refactor from CIB-first to constants-first validation approach
src/ansible.cfg	Changed stdout callback from yaml to default
scripts/setup.sh	Added Azure CLI installation and updated dependency management
docs/high_availability/*.md	Fixed relative link paths for better navigation
docs/SETUP.MD	Created comprehensive setup guide with technical requirements
docs/HIGH_AVAILABILITY.md	Streamlined by removing setup instructions and referencing new guide
.github/copilot-instructions.md	Added detailed project context and coding partnership guidelines

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[hdamecharla]

approved