Skip to content

Commit e863fd6

Browse files
author
naman-msft
committed
updated readme with content filters
1 parent d30d69e commit e863fd6

File tree

2 files changed

+364
-4
lines changed

2 files changed

+364
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ These experiences utilize [Innovation Engine](https://github.com/Azure/Innovatio
1919
- [Frequently Asked Questions (FAQs)](#frequently-asked-questions-faqs)
2020
- [Contact Information for Exec Docs](#contact-information-for-exec-docs)
2121

22+
I'll update the highlighted section with the clarified information about command execution limitations:
23+
2224
## Selecting Documentation for Exec Docs
2325

2426
Not all documentation is suitable for conversion to Exec Docs. Use these filters to determine if a document can be effectively converted:
@@ -44,15 +46,16 @@ Not all documentation is suitable for conversion to Exec Docs. Use these filters
4446
4547
2. **Command Execution Limitations**
4648
- **Not supported for direct execution:**
47-
- PowerShell scripts
48-
- Python, Ruby, or Node.js code
49-
- SQL commands
49+
- PowerShell scripts
5050
- GUI-based instructions
51+
- Direct code blocks containing Python, SQL, or other languages (these should be executed via BASH commands)
5152

5253
- **Supported execution context:**
5354
- Commands that run in a Linux/bash environment
5455
- Azure CLI commands
55-
- Terraform commands (with appropriate setup)
56+
- Terraform commands (works without any special setup)
57+
- Python scripts executed via BASH (e.g., `python myApp.py`)
58+
- SQL queries executed via database CLI tools
5659

5760
**Example of supported command:**
5861
```markdown
@@ -69,6 +72,8 @@ Not all documentation is suitable for conversion to Exec Docs. Use these filters
6972
```
7073
```
7174

75+
>**Note:** The key principle is that if a code block can be executed in a BASH terminal as written (the way a human would execute it), then it will work with Exec Docs.
76+
7277
3. **Azure Portal Custom Cloud Shell Constraints**
7378
- **Supported scenarios:**
7479
- Standard Azure resource operations (create, read, update, delete)

0 commit comments

Comments
 (0)