Skip to content

Commit 41624bb

Browse files
authored
Update README.md
1 parent 43fb362 commit 41624bb

File tree

1 file changed

+12
-32
lines changed

1 file changed

+12
-32
lines changed

README.md

Lines changed: 12 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,67 +25,47 @@ I'll update the highlighted section with the clarified information about command
2525

2626
Not all documentation is suitable for conversion to Exec Docs. Use these filters to determine if a document can be effectively converted:
2727

28-
1. **Supported Code Block Types**
29-
- The document must contain code blocks using at least one of these types:
30-
- `bash`
31-
- `azurecli`
32-
- `azure-cli-interactive`
33-
- `azurecli-interactive`
34-
- `terraform`
35-
36-
**Example:**
37-
```markdown
38-
```bash
39-
export REGION="eastus"
40-
export RESOURCE_GROUP="myResourceGroup"
41-
az group create --name $RESOURCE_GROUP --location $REGION
42-
```
43-
```
44-
45-
>**Note:** You can include code blocks of any type in your documentation for human readers, but only the types listed above will be executed by Innovation Engine. Other code block types will be displayed but ignored during execution.
28+
1. **Command Execution Limitations**
29+
- **Supported:**
30+
- Any command that can run in a BASH terminal
31+
- Azure CLI commands (e.g. azurecli, azure-cli-interactive, azurecli-interactive)
32+
- Terraform commands
4633

47-
2. **Command Execution Limitations**
4834
- **Not supported:**
4935
- PowerShell scripts
5036
- GUI-based instructions
5137
- Commands requiring `sudo` privileges
5238
- Direct code blocks of languages that aren't bash/shell commands
5339

54-
- **Supported:**
55-
- Any command that can run in a BASH terminal
56-
- Azure CLI commands
57-
- Terraform commands
58-
- Python scripts executed via BASH (e.g., `python myApp.py`)
59-
- SQL queries executed via database CLI tools
60-
6140
**Example of supported command:**
6241
```markdown
6342
```bash
64-
export VM_NAME="my-virtual-machine"
65-
export RESOURCE_GROUP="my-resource-group"
66-
az vm create --name $VM_NAME --resource-group $RESOURCE_GROUP --image UbuntuLTS
43+
export REGION="eastus"
44+
export RESOURCE_GROUP="myResourceGroup"
45+
az group create --name $RESOURCE_GROUP --location $REGION
6746
```
6847
```
6948

70-
**Example of unsupported SQL query (won't work):**
49+
**Example of unsupported command (SQL query below won't work):**
7150
```markdown
7251
```sql
7352
INSERT INTO myTable (name, value) VALUES ('test', 123);
7453
```
7554
```
7655

77-
**Example of supported SQL command (will work):**
56+
**Example of supported command (SQL query below will work):**
7857
```markdown
7958
```bash
8059
export DATABASE_NAME="mydb"
8160
export TABLE_NAME="myTable"
8261
psql -d $DATABASE_NAME -c "INSERT INTO $TABLE_NAME (name, value) VALUES ('test', 123);"
8362
```
8463
```
64+
>**Note:** You can include code blocks of any type in your documentation for human readers, but only the types listed above in the "Supported Code Block Types" section will be executed by Innovation Engine. Other code block types will be displayed but ignored during execution.
8565
8666
>**Note:** The key principle is simple: if you can run it in a BASH terminal as written, it will work with Exec Docs (although at this time `sudo` is not supported). Code blocks in other languages won't be executed directly but can be included for human readers.
8767
88-
3. **Azure Portal Custom Cloud Shell Constraints**
68+
2. **Azure Portal Custom Cloud Shell Constraints**
8969
- **Supported scenarios:**
9070
- Standard Azure resource operations (create, read, update, delete)
9171
- Commands running within the user's subscription scope

0 commit comments

Comments
 (0)