Skip to content

Commit 74044b5

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

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Not all documentation is suitable for conversion to Exec Docs. Use these filters
3434

3535
**Example:**
3636
```markdown
37-
```bash
38-
az group create --name myResourceGroup --location eastus
39-
```
37+
```bash
38+
az group create --name myResourceGroup --location eastus
39+
```
4040
```
4141

4242
>**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._
@@ -57,10 +57,10 @@ Not all documentation is suitable for conversion to Exec Docs. Use these filters
5757

5858
**Example of supported command:**
5959
```markdown
60-
```bash
61-
export VM_NAME="myVM"
62-
az vm create --name $VM_NAME --resource-group myResourceGroup --image UbuntuLTS
63-
```
60+
```bash
61+
export VM_NAME="myVM"
62+
az vm create --name $VM_NAME --resource-group myResourceGroup --image UbuntuLTS
63+
```
6464
```
6565

6666
3. **Azure Portal Custom Cloud Shell Constraints**
@@ -77,17 +77,17 @@ Not all documentation is suitable for conversion to Exec Docs. Use these filters
7777

7878
**Example of supported command:**
7979
```markdown
80-
```bash
81-
az group create --name myResourceGroup --location eastus
82-
```
80+
```bash
81+
az group create --name myResourceGroup --location eastus
82+
```
8383
```
8484

8585
**Example of potentially unsupported command:**
8686
```markdown
87-
```bash
88-
# This requires elevated Graph API permissions and would fail
89-
az ad app create --display-name myApp --native-app
90-
```
87+
```bash
88+
# This requires elevated Graph API permissions and would fail
89+
az ad app create --display-name myApp --native-app
90+
```
9191
```
9292

9393
This filter system ensures that you select documentation that can be effectively transformed into executable docs that provide value through automated deployment capabilities.
@@ -162,7 +162,7 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
162162
**Example:**
163163

164164
```markdown
165-
# Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using Azure CLI
165+
# Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using Azure CLI
166166
```
167167

168168
### Writing Requirements
@@ -404,12 +404,12 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
404404

405405
**Deeplink Template:**
406406
```markdown
407-
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://ms.portal.azure.com/#view/Microsoft_Azure_CloudNative/SubscriptionSelectionPage.ReactView/isLearnMode~/true/referer/docs/tutorialKey/<add_file_path_of_Exec_Doc>)
407+
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://ms.portal.azure.com/#view/Microsoft_Azure_CloudNative/SubscriptionSelectionPage.ReactView/isLearnMode~/true/referer/docs/tutorialKey/<add_file_path_of_Exec_Doc>)
408408
```
409409
410410
**Deeplink for Example Exec Doc:**
411411
```markdown
412-
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://ms.portal.azure.com/#view/Microsoft_Azure_CloudNative/SubscriptionSelectionPage.ReactView/isLearnMode~/true/referer/docs/tutorialKey/azure-docs%2farticles%2faks%2fquick-kubernetes-deploy-cli.md)
412+
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://ms.portal.azure.com/#view/Microsoft_Azure_CloudNative/SubscriptionSelectionPage.ReactView/isLearnMode~/true/referer/docs/tutorialKey/azure-docs%2farticles%2faks%2fquick-kubernetes-deploy-cli.md)
413413
```
414414
415415
**Example of Button in Live Exec Doc:**

0 commit comments

Comments
 (0)