updated readme#191
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation files by adding an install guide and refining several promptbook and Logic App configuration details for Security Copilot reporting. Key changes include:
- Updating readme.md files and promptbook markdown documents with clearer instructions and prerequisite details.
- Adding a comprehensive install guide (install-guide.md) with step-by-step setup procedures.
- Modifying YAML configuration files to improve parameter descriptions and examples.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Logic Apps/ciso-reporting/readme.md | Updated link formatting and added install guide link. |
| Logic Apps/ciso-reporting/promptbook-posture-analysis.md | Revised prompt explanations and updated Logic App template links. |
| Logic Apps/ciso-reporting/promptbook-incident-analysis.md | Updated prompt instructions and parameter details. |
| Logic Apps/ciso-reporting/install-guide.md | Added a new install guide with detailed setup procedures. |
| Logic Apps/ciso-reporting/ciso-posture-summary-man.yaml | Updated description text to clarify severity concatenation requirements. |
| Logic Apps/ciso-reporting/ciso-incidents-summary-man.yaml | Modified severity formatting instructions for consistency. |
| Logic Apps/CfS-SendPromptbookResultsByEmail/readme.md | Updated the deployment button URL to reflect the correct repository path. |
Comments suppressed due to low confidence (1)
Logic Apps/ciso-reporting/install-guide.md:134
- The word 'modifiy' should be corrected to 'modify'.
You have then to modifiy your copy of the file [ciso-incidents-summary-man.yaml](https://github.com/Azure/Security-Copilot/blob/main/Logic%20Apps/ciso-reporting/ciso-incidents-summary-man.yaml)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request updates documentation by adding an install guide and revising related markdown files with updated links, instructions, and parameter details to support the Security Copilot solution setup.
- Updated readme file with new install guide link
- Revised promptbook documentation for incident and posture analyses with improved instructions
- Added detailed install guide and updated YAML files with consistent parameter descriptions
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Logic Apps/ciso-reporting/readme.md | Updated link formatting and added install guide reference |
| Logic Apps/ciso-reporting/promptbook-posture-analysis.md | Enhanced prompt descriptions and parameter instructions |
| Logic Apps/ciso-reporting/promptbook-incident-analysis.md | Revised incident analysis instructions and updated template references |
| Logic Apps/ciso-reporting/install-guide.md | Added comprehensive installation and setup guide |
| Logic Apps/ciso-reporting/ciso-posture-summary-man.yaml | Extended description for severity formatting instructions |
| Logic Apps/ciso-reporting/ciso-incidents-summary-man.yaml | Updated severity formatting instructions for consistency |
| Logic Apps/CfS-SendPromptbookResultsByEmail/readme.md | Updated deployment URL to reflect repository changes |
Comments suppressed due to low confidence (2)
Logic Apps/ciso-reporting/promptbook-posture-analysis.md:39
- The word 'Paramter' is misspelled; it should be 'Parameter'.
### Value for the Logic App Paramter 'ReplacePromptsInOutput'
Logic Apps/ciso-reporting/promptbook-incident-analysis.md:97
- The header 'Paramters' is misspelled; please correct it to 'Parameters'.
## Paramters related to the responses of the promptbook
KwachSean
left a comment
There was a problem hiding this comment.
**Summary **
Logic Apps/CfS-SendPromptbookResultsByEmail/readme.md
Updated the URL for the "Deploy to Azure" button to point to the Azure repository instead of the stefanpems repository.
Logic Apps/ciso-reporting/ciso-incidents-summary-man.yaml
Modified the descriptions to specify that severities should be listed with the first letter in uppercase.
Logic Apps/ciso-reporting/ciso-posture-summary-man.yaml
Added a line in the description to specify that severities should be listed with the first letter in uppercase.
Logic Apps/ciso-reporting/images/yt.png
Added a new image file.
Logic Apps/ciso-reporting/install-guide.md
Added a new installation guide with detailed setup procedures for various components related to Security Copilot.
Logic Apps/ciso-reporting/promptbook-incident-analysis.md
Updated the prompt descriptions to include instructions on how to format severities.
Updated references to point to the Azure repository instead of the stefanpems repository.
Logic Apps/ciso-reporting/promptbook-posture-analysis.md
Updated the promptbook description and prompts.
Added references to articles and guidelines for improving the promptbook.
Updated references to point to the Azure repository instead of the stefanpems repository.
Logic Apps/ciso-reporting/readme.md
Added a link to the install guide and updated the link description.
These changes primarily involve updates to documentation, descriptions, and references to ensure consistency and accuracy.
Added the install guide (md file) and updated the readme (md file)