Skip to content

Commit 7dfe87b

Browse files
author
naman-msft
committed
updated documentation with technical constraints
1 parent e10542b commit 7dfe87b

10 files changed

+884
-235
lines changed

README.md

Lines changed: 75 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ These experiences utilize [Innovation Engine](https://github.com/Azure/Innovatio
88

99
## Table of Contents
1010

11+
- [Selecting Documentation for Exec Docs](#selecting-documentation-for-exec-docs)
1112
- [How to Write an Exec Doc](#how-to-write-an-exec-doc)
1213
- [Training Resources (Optional)](#training-resources-optional)
1314
- [Setup](#setup)
@@ -18,6 +19,79 @@ These experiences utilize [Innovation Engine](https://github.com/Azure/Innovatio
1819
- [Frequently Asked Questions (FAQs)](#frequently-asked-questions-faqs)
1920
- [Contact Information for Exec Docs](#contact-information-for-exec-docs)
2021

22+
## Selecting Documentation for Exec Docs
23+
24+
Not all documentation is suitable for conversion to Exec Docs. Use these filters to determine if a document can be effectively converted:
25+
26+
### Technical Constraints
27+
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+
35+
**Example:**
36+
```markdown
37+
```bash
38+
az group create --name myResourceGroup --location eastus
39+
```
40+
```
41+
42+
>**Note:** This rule does not apply to output code blocks, which are used to display the results of commands, scripts, or other operations. These blocks help in illustrating what the expected output should look like. They include, but are not limited to, the following types: _output, json, yaml, console, text, and log._
43+
44+
>**Note:** While Innovation Engine can _parse_ a code block of any type, given its current features, it can only _execute_ code blocks of the types above. So, it is important to ensure that the code blocks in your Exec Doc are of the types above.
45+
46+
2. **Command Execution Limitations**
47+
- **Not supported for direct execution (unless executed via bash):**
48+
- PowerShell scripts
49+
- Python, Ruby, or Node.js code
50+
- SQL commands
51+
- GUI-based instructions
52+
53+
- **Supported execution context:**
54+
- Commands that run in a Linux/bash environment
55+
- Azure CLI commands
56+
- Terraform commands (with appropriate setup)
57+
58+
**Example of supported command:**
59+
```markdown
60+
```bash
61+
export VM_NAME="myVM"
62+
az vm create --name $VM_NAME --resource-group myResourceGroup --image UbuntuLTS
63+
```
64+
```
65+
66+
3. **Azure Portal Custom Cloud Shell Constraints**
67+
- **Supported scenarios:**
68+
- Standard Azure resource operations (create, read, update, delete)
69+
- Commands running within the user's subscription scope
70+
- Standard service deployments (VMs, storage, networking)
71+
72+
- **Not supported without special configuration:**
73+
- Commands requiring elevated Microsoft Graph API permissions
74+
- Operations needing KeyVault special access
75+
- Cross-subscription or tenant-level operations
76+
- Commands requiring admin consent
77+
78+
**Example of supported command:**
79+
```markdown
80+
```bash
81+
az group create --name myResourceGroup --location eastus
82+
```
83+
```
84+
85+
**Example of potentially unsupported command:**
86+
```markdown
87+
```bash
88+
# This requires elevated Graph API permissions and would fail
89+
az ad app create --display-name myApp --native-app
90+
```
91+
```
92+
93+
This filter system ensures that you select documentation that can be effectively transformed into executable docs that provide value through automated deployment capabilities.
94+
2195
## How to Write an Exec Doc
2296

2397
Follow these steps in sequence to write an Exec Doc either by converting an existing Azure Doc i.e. building on top of the author's work or from scratch i.e. you are the author _(read the Notes in any step for more information)_:
@@ -81,26 +155,7 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
81155
│ └── my-script.yaml
82156
```
83157

84-
6. Code blocks are used to provide examples, commands, or other code snippets in Exec Docs. They are distinguished by a triple backtick (```) at the start and end of the block.
85-
86-
Ensure that the Exec Doc contains at least 1 code block and every input code block's type in the Exec Doc is taken from this list:
87-
88-
- bash
89-
- azurecli
90-
- azure-cli-interactive
91-
- azurecli-interactive
92-
93-
**Example:**
94-
95-
```bash
96-
az group create --name $MY_RESOURCE_GROUP_NAME --location $REGION
97-
```
98-
99-
>**Note:** This rule does not apply to output code blocks, which are used to display the results of commands, scripts, or other operations. These blocks help in illustrating what the expected output should look like. They include, but are not limited to, the following types: _output, json, yaml, console, text, and log._
100-
101-
>**Note:** While Innovation Engine can _parse_ a code block of any type, given its current features, it can only _execute_ code blocks of the types above. So, it is important to ensure that the code blocks in your Exec Doc are of the types above.
102-
103-
7. Headings are used to organize content in a document. The number of hashes indicates the level of the heading. For example, a single hash (#) denotes an h1 heading, two hashes (##) denote an h2 heading, and so on. Innovation Engine uses headings to structure the content of an Exec Doc and to provide a clear outline of the document's contents.
158+
6. Headings are used to organize content in a document. The number of hashes indicates the level of the heading. For example, a single hash (#) denotes an h1 heading, two hashes (##) denote an h2 heading, and so on. Innovation Engine uses headings to structure the content of an Exec Doc and to provide a clear outline of the document's contents.
104159

105160
Ensure there is at least one h1 heading in the Exec Doc, denoted by a single hash (#) at the start of the line.
106161

0 commit comments

Comments
 (0)