Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
339 commits
Select commit Hold shift + click to select a range
595f582
updated docs;
Feb 3, 2025
ec27844
updated docs;
Feb 3, 2025
b569f6e
updated docs;
Feb 3, 2025
2d85d21
updated docs;
Feb 3, 2025
75e55de
updated docs;
Feb 3, 2025
ba9d54d
updated docs;
Feb 3, 2025
733e011
updated docs;
Feb 3, 2025
f7dcc0f
updated docs;
Feb 3, 2025
3e5c676
updated docs;
Feb 3, 2025
2a7df29
updated docs;
Feb 3, 2025
1ca3910
updated docs;
Feb 3, 2025
363ee9f
Delete scenarios/README.md
pjsingh28 Feb 3, 2025
9d1dccf
Merge pull request #647 from MicrosoftDocs/test_new
pjsingh28 Feb 4, 2025
72a00bb
Style changes AKS
aamini7 Feb 4, 2025
3855136
Fix styles for LEMP
aamini7 Feb 4, 2025
85a1872
Fix style for AKS Web app
aamini7 Feb 4, 2025
f8bfcbe
Style fixes perf
aamini7 Feb 4, 2025
6313254
Fix python style
aamini7 Feb 4, 2025
85c1e22
Fix
aamini7 Feb 4, 2025
1f70b2e
Fix Linux container style
aamini7 Feb 4, 2025
62ed18a
Clean style for accelerated networking
aamini7 Feb 4, 2025
834ade0
Fix wordpress style
aamini7 Feb 4, 2025
23449ef
Fix identity doc
aamini7 Feb 4, 2025
d51e70e
Fix Confidential
aamini7 Feb 4, 2025
6e536f1
Fix missing accelerated
aamini7 Feb 4, 2025
2392954
Rename
aamini7 Feb 4, 2025
0882afb
Merge pull request #648 from MicrosoftDocs/test_styles
pjsingh28 Feb 4, 2025
803b908
updated metadata.json with all documentation links
Feb 5, 2025
59a8eea
Fix style
aamini7 Feb 7, 2025
80e9e5d
Merge pull request #649 from MicrosoftDocs/test_styles
pjsingh28 Feb 7, 2025
7a08cc1
Update metadata.json
pjsingh28 Feb 11, 2025
6e67893
Update metadata.json
pjsingh28 Feb 11, 2025
c873b98
Merge pull request #651 from MicrosoftDocs/test_fixaqc
pjsingh28 Feb 11, 2025
5b48d4e
Rename
aamini7 Feb 11, 2025
a084a53
Merge pull request #652 from MicrosoftDocs/test_fixes
pjsingh28 Feb 11, 2025
1d96eba
Rename README
aamini7 Feb 11, 2025
73e2b7b
Merge pull request #653 from MicrosoftDocs/test_fixes
aamini7 Feb 11, 2025
7b1cade
Rename Kaito
aamini7 Feb 11, 2025
4c3523b
Merge pull request #654 from MicrosoftDocs/test_fixes
aamini7 Feb 11, 2025
b79fdc8
Update metadata.json
pjsingh28 Feb 11, 2025
0048833
Rename aks doc
aamini7 Feb 11, 2025
87eb637
Merge pull request #659 from MicrosoftDocs/test_rename_aks
aamini7 Feb 11, 2025
e4859e7
Rename AKS again
aamini7 Feb 11, 2025
ebaeca6
Merge pull request #660 from MicrosoftDocs/test_rename_aks
pjsingh28 Feb 11, 2025
38e4a28
Fix typo
aamini7 Feb 11, 2025
fe5fda5
Merge pull request #661 from MicrosoftDocs/test_rename_aks
aamini7 Feb 11, 2025
dfe0d84
Update metadata.json
pjsingh28 Feb 11, 2025
4488829
Rename IGonAks
aamini7 Feb 11, 2025
7309b90
Rename Create AKS Web App
aamini7 Feb 11, 2025
8f782c8
Update metadata.json
pjsingh28 Feb 12, 2025
0167774
Merge pull request #662 from MicrosoftDocs/test_updateaqctitles
pjsingh28 Feb 12, 2025
dc5a3cf
Style changes
aamini7 Feb 12, 2025
6e4c108
Merge pull request #663 from MicrosoftDocs/test_fixes
pjsingh28 Feb 12, 2025
465ba86
Fix
aamini7 Feb 12, 2025
b7ba24a
Merge pull request #664 from MicrosoftDocs/test_fixes
aamini7 Feb 12, 2025
d39790e
Remove last 2 steps
aamini7 Feb 12, 2025
de0cb98
Merge pull request #665 from MicrosoftDocs/test_fixes
aamini7 Feb 12, 2025
356c53d
terraform fixes
aamini7 Feb 20, 2025
48043ea
Fix readme
aamini7 Feb 20, 2025
91d85a7
Fix key vault
aamini7 Feb 24, 2025
6e5544b
Fixes
aamini7 Feb 24, 2025
fcf07ed
Rename
aamini7 Feb 25, 2025
1bf3cf8
Change SKU
aamini7 Feb 25, 2025
dd6db60
Merge remote-tracking branch 'origin/main' into test_terraform
aamini7 Feb 25, 2025
ded7284
make inactive
aamini7 Feb 25, 2025
fc066b6
Rename
aamini7 Feb 25, 2025
d8c99d6
WIP
aamini7 Feb 25, 2025
3f29ae6
WIP
aamini7 Feb 25, 2025
fd3b178
Rename
aamini7 Feb 25, 2025
805a02f
Wip
aamini7 Feb 25, 2025
2eadfac
WIP
aamini7 Feb 25, 2025
de35561
Fixes
aamini7 Feb 25, 2025
9d8645a
Move
aamini7 Feb 25, 2025
2d99179
Add back network profile
aamini7 Feb 25, 2025
c2c6fe8
WIP
aamini7 Feb 25, 2025
e41428b
Fix
aamini7 Feb 25, 2025
bf9b3a6
updated file
Feb 26, 2025
19fd699
added 2 new support docs
Feb 26, 2025
d4692f2
wip
aamini7 Feb 26, 2025
502d08b
Fix
aamini7 Feb 26, 2025
91933da
WIP
aamini7 Feb 26, 2025
6d77e53
rename
aamini7 Feb 26, 2025
0d689d5
Working
aamini7 Feb 26, 2025
175eda5
Add venv to gitignore
aamini7 Feb 26, 2025
d677471
del
aamini7 Feb 26, 2025
d34bd3a
ui tweaks
aamini7 Feb 26, 2025
69921b3
Fix
aamini7 Feb 26, 2025
2ef60b7
fix
aamini7 Feb 26, 2025
eced908
Fixes
aamini7 Feb 26, 2025
bf975d8
Remove certmanager and nginx
aamini7 Feb 27, 2025
c40b313
clean
aamini7 Feb 27, 2025
c08e733
Fixes
aamini7 Feb 27, 2025
442fdc8
Minor tweak
aamini7 Feb 27, 2025
b8099ad
Fixes
aamini7 Feb 27, 2025
54e909f
Remove unused resources
aamini7 Feb 27, 2025
31829ac
updated ai tool
Feb 28, 2025
69124bd
Rename
aamini7 Feb 28, 2025
f5ea6c2
Fixes
aamini7 Feb 28, 2025
74780d5
Fixes
aamini7 Mar 1, 2025
24339d8
fix
aamini7 Mar 1, 2025
a87162b
Fix
aamini7 Mar 1, 2025
a3450bb
Fix
aamini7 Mar 1, 2025
55ae013
Fix
aamini7 Mar 1, 2025
8f325c2
added 3rd support doc
Mar 3, 2025
5c0eebf
added 3rd support doc
Mar 3, 2025
b65a2b6
Fix
aamini7 Mar 3, 2025
4a96ec7
Reduce replica count
aamini7 Mar 3, 2025
6ad16bb
Update prompt
aamini7 Mar 3, 2025
3f2ad29
Update version
aamini7 Mar 3, 2025
f32e4fc
Update eta
aamini7 Mar 3, 2025
fdc5420
Fix
aamini7 Mar 3, 2025
6af4d22
added new doc using AI agent!
Mar 4, 2025
4f75a25
Optimize app
aamini7 Mar 4, 2025
b8eb028
Add spinner
aamini7 Mar 4, 2025
dc7b464
Emoji
aamini7 Mar 4, 2025
0f6ba25
Remove comment
aamini7 Mar 4, 2025
4a4fb71
added 4 new ai generated conversion docs
Mar 4, 2025
11aba81
added toms vnet doc
Mar 4, 2025
aab66af
added 2 new ai docs
Mar 4, 2025
2479a1e
Update metadata.json
pjsingh28 Mar 4, 2025
3e9c1de
Update metadata.json
pjsingh28 Mar 4, 2025
1e37504
added a bunch of more functionalities in the ai tool and its readme
Mar 5, 2025
22f4088
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs into …
Mar 5, 2025
ccabc95
Update metadata.json
pjsingh28 Mar 5, 2025
fb40f0e
Minor tweaks
aamini7 Mar 5, 2025
4ef52ee
updated tool
Mar 6, 2025
21668d5
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs into …
Mar 6, 2025
8fa1a14
updated tool
Mar 6, 2025
14f103b
updated readme around tool
Mar 6, 2025
d7dd7a8
updated doc and tool
Mar 6, 2025
e10542b
updated final tool
Mar 7, 2025
7dfe87b
updated documentation with technical constraints
Mar 10, 2025
74044b5
updated documentation with technical constraints
Mar 10, 2025
06fe6de
updated documentation with technical constraints
Mar 10, 2025
c851540
updated documentation with technical constraints
Mar 10, 2025
105c55b
updated documentation with technical constraints
Mar 10, 2025
f353531
updated docs
Mar 10, 2025
f9d370a
Merge pull request #632 from MicrosoftDocs/test_terraform
pjsingh28 Mar 10, 2025
8a3a602
Update README.md
naman-msft Mar 10, 2025
fe0baab
updated docs
Mar 10, 2025
0608a0b
updated docs
Mar 10, 2025
a19398b
updated docs
Mar 10, 2025
d30d69e
Merge branch 'test_new' of github.com:MicrosoftDocs/executable-docs i…
Mar 10, 2025
e863fd6
updated readme with content filters
Mar 11, 2025
459bfa5
updated readme with content filters
Mar 11, 2025
ace5fa5
Update ada.py
naman-msft Mar 11, 2025
c0ce34c
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs into …
Mar 11, 2025
e1628b1
Update README.md
naman-msft Mar 11, 2025
ce9318a
Update README.md
naman-msft Mar 11, 2025
3a66d3a
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs into …
Mar 12, 2025
35ec0f1
updated documentation
Mar 12, 2025
71fad60
updated documentation
Mar 12, 2025
685e05b
Update README.md
naman-msft Mar 12, 2025
c9bf6ec
Update README.md
naman-msft Mar 12, 2025
7722d6a
updated documentation
Mar 12, 2025
43fb362
Update README.md
naman-msft Mar 12, 2025
0042b23
updated documentation
Mar 12, 2025
308232e
updated documentation
Mar 12, 2025
41624bb
Update README.md
naman-msft Mar 12, 2025
c0c36e1
Update README.md
naman-msft Mar 12, 2025
21a854e
updated documentation
Mar 12, 2025
f7430a9
updated documentation
Mar 12, 2025
6386522
updated documentation
Mar 12, 2025
33a7dbe
Update README.md
naman-msft Mar 12, 2025
42f76a8
updated documentation
Mar 12, 2025
edabbaa
updated documentation
Mar 12, 2025
02cad3a
updated documentation
Mar 12, 2025
682fee7
updated documentation
Mar 12, 2025
7a8dbba
updated documentation
Mar 12, 2025
f184fb4
updated documentation
Mar 12, 2025
aa56f28
updated commands
Mar 13, 2025
0a6bcdb
updated doc
Mar 13, 2025
b1bf49f
Make scenario active
aamini7 Mar 11, 2025
fa919a9
Fix bugs
aamini7 Mar 13, 2025
a5c316b
Merge pull request #670 from MicrosoftDocs/test_terraform
aamini7 Mar 13, 2025
918131e
updated metadata
Mar 17, 2025
175804f
added support request as next step for support docs
Mar 17, 2025
e4eb3b4
added flatcar doc in exec docs
Mar 18, 2025
78d5d24
updated doc
Mar 19, 2025
5f8c6f3
updated files and added new docs
Mar 20, 2025
e75ea8c
updated files and added new docs
Mar 20, 2025
a9a0647
updated docs
Mar 21, 2025
e38f6b9
added new docs
Mar 26, 2025
42bf42d
updated latest metadata pending new converted docs
Mar 28, 2025
30d7205
added a bunch of new converted docs and updated their metadata to be …
Mar 28, 2025
6613502
updated docs
Mar 29, 2025
9cedeea
added new docs
Mar 30, 2025
387002b
added aks doc on windows node
Mar 31, 2025
e6dbd42
added 2 new aks docs
Apr 1, 2025
6b50195
added 2 new aks docs
Apr 1, 2025
17bad14
added new aks docs
Apr 1, 2025
8832384
added new doc
Apr 1, 2025
0722745
ready to test all exec docs
Apr 3, 2025
6445b55
updated docs
Apr 4, 2025
eb1ed0a
updated doc
Apr 4, 2025
95a41c5
updated doc
Apr 4, 2025
ee46c62
updated docs
Apr 4, 2025
b3a2a9a
updated docs
Apr 4, 2025
8467d5a
updated docs
Apr 4, 2025
11d4bf9
updated docs
Apr 4, 2025
bd5fea5
updated docs
Apr 4, 2025
2fd3ac5
updated docs
Apr 4, 2025
48fed94
updated docs
Apr 4, 2025
2befa31
updated doc;
Apr 4, 2025
3e0af05
updated doc;
Apr 4, 2025
e71d61e
updated doc;
Apr 4, 2025
20ca325
updated doc;
Apr 4, 2025
2db4765
updated doc;
Apr 5, 2025
2ee3fb4
ready to merge;
Apr 5, 2025
7971ef3
updated documentationurl of a scenario
Apr 8, 2025
2819301
updated ada script
Apr 9, 2025
e780199
added new functionalities
Apr 9, 2025
f80b78b
added new functionalities
Apr 9, 2025
3f73d00
updated ada to v3
Apr 9, 2025
96ffb8f
updated ada with a bunch more functionality around taking user input …
Apr 9, 2025
f212627
updated ada with a bunch more functionality around taking user input …
Apr 9, 2025
238cd90
ada ready for webapp
Apr 9, 2025
c1b4dad
updated tool
Apr 9, 2025
01a78c5
updated tools
Apr 9, 2025
e15d741
updating the tools folder
Apr 9, 2025
f0b2407
removed the tools folder for easier PR review. it all lives in test_a…
Apr 10, 2025
01028ff
removed inactive metadata
Apr 10, 2025
f6ad229
Updated ada.py
naman-msft Apr 21, 2025
dc8c576
Update README.md
naman-msft Apr 21, 2025
bc627d6
Create Dockerfile
naman-msft Apr 21, 2025
5c4af2b
Delete tools/converted_test.md
naman-msft Apr 21, 2025
c66f2f5
Delete tools/generated_exec_doc.md
naman-msft Apr 21, 2025
d0c476f
Delete tools/stdout.txt
naman-msft Apr 21, 2025
eddf8c1
Delete tools/execution_log.csv
naman-msft Apr 21, 2025
bf2a7cd
Create requirements.txt
naman-msft Apr 21, 2025
802584e
Create seo-checklist.md
naman-msft Apr 21, 2025
bd9dbdd
Update README.md
naman-msft Apr 22, 2025
4322251
added the tools folder with ada - nothing to do with the scenarios fo…
Apr 30, 2025
3c6f881
Merge pull request #676 from MicrosoftDocs/test_new
naman-msft Apr 30, 2025
c97cc82
Update README.md
naman-msft May 13, 2025
682114f
Update README.md
naman-msft May 13, 2025
0ebfd07
added a cleanup script to run in Ross dev account daily to prevent co…
May 21, 2025
d9e7e26
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs
May 21, 2025
0609cd9
gave write permissions to the id token
May 21, 2025
a5c4ba0
fixed resource deletion logic
May 21, 2025
e3acc7f
tested and finalized deletion script and it will run on 11:11 UTC eve…
May 21, 2025
9d11db6
tested and finalized deletion script and it will run on 11:11 UTC eve…
May 21, 2025
ea0d8c4
Update script-cleanup.yml
naman-msft Jun 2, 2025
66d0dd1
added new batch of exec docs as of june 24, 2025 and tested them read…
Jun 24, 2025
09aba4e
Update metadata.json
pjsingh28 Jun 27, 2025
57b6ce6
Merge pull request #677 from MicrosoftDocs/test_batch_24june2025
pjsingh28 Jun 27, 2025
a93f068
updated metadata to reflect changes
Jun 27, 2025
95601f3
updated metadata and it works now with next steps and source URLs
Jun 27, 2025
2707646
Merge pull request #678 from MicrosoftDocs/test_batch_24june2025
naman-msft Jun 27, 2025
3f828ff
Update script-cleanup.yml
naman-msft Sep 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/script-cleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Daily RG Cleanup

on:
schedule:
# runs every day at 11:11 UTC
- cron: '11 11 * * *'
workflow_dispatch:

permissions:
contents: write
id-token: write
issues: write

jobs:
cleanup:
runs-on: ubuntu-latest
steps:
- name: 'Az CLI login'
uses: azure/login@v1
with:
client-id: ${{ secrets.AZURE_CLIENT_ID }}
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}

- name: Install jq
run: sudo apt-get update && sudo apt-get install -y jq

- name: Cleanup Resource Groups
run: |
echo "Fetching all resource groups in the subscription..."
rgs_json=$(az group list --output json)

# don't exit on errors in this block
set +e

echo "Attempting to delete all resource groups except 'exec-docs-ai' and those containing 'mcp'..."
echo "$rgs_json" |
jq -r '.[] | select(.name != "exec-docs-ai" and (.name | contains("mcp") | not)) | .name' |
while read -r rg_name; do
if [[ -z "$rg_name" ]]; then
echo "Skipping empty resource group name."
continue
fi
echo -n "Deleting $rg_name… "
az group delete \
--name "$rg_name" \
--yes \
--no-wait \
&& echo "OK" \
|| echo "⚠️ Skipped (deny-assignment or other error)"
done

# restore "exit on error" if you need it later
set -e
4 changes: 2 additions & 2 deletions .github/workflows/sync.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: Sync Markdown Files

on:
schedule:
- cron: '0 15 * * *'
# schedule:
# - cron: '0 15 * * *'
workflow_dispatch:

permissions:
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ _themes*/
_repo.*/

.openpublishing.buildcore.ps1
ie.log
ie.log
report.json
17 changes: 0 additions & 17 deletions LICENSE-CODE

This file was deleted.

136 changes: 100 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ These experiences utilize [Innovation Engine](https://github.com/Azure/Innovatio

## Table of Contents

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

I'll update the highlighted section with the clarified information about command execution limitations:

## Selecting Documentation for Exec Docs

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

1. **Command Execution Limitations**
- **Supported scenarios:**
- Any command that can run in a BASH terminal (e.g. azurecli, azure-cli-interactive, azurecli-interactive commands)

- **Not supported currently:**
- PowerShell scripts
- GUI-based instructions
- Commands requiring `sudo` privileges
- Direct code blocks of languages that aren't bash/shell commands

**Example of supported command:**
```markdown
```bash
export REGION="eastus"
export RESOURCE_GROUP="myResourceGroup"
az group create --name $RESOURCE_GROUP --location $REGION
```
```

**Example of unsupported command (SQL query below won't work):**
```markdown
```sql
INSERT INTO myTable (name, value) VALUES ('test', 123);
```
```

**Example of supported command (SQL query below will work):**
```markdown
```bash
export DATABASE_NAME="mydb"
export TABLE_NAME="myTable"
psql -d $DATABASE_NAME -c "INSERT INTO $TABLE_NAME (name, value) VALUES ('test', 123);"
```
```
>**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.

>**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.

2. **Azure Portal Custom Cloud Shell Constraints**
- **Supported scenarios:**
- Standard Azure resource operations (create, read, update, delete)
- Commands running within the user's subscription scope
- Standard service deployments (VMs, storage, networking)

- **Not supported currrently:**
- Commands requiring elevated Microsoft Graph API permissions
- Operations needing KeyVault special access
- Cross-subscription or tenant-level operations
- Commands requiring admin consent

**Example of supported command:**
```markdown
```bash
export RESOURCE_GROUP="myResourceGroup"
export LOCATION="eastus"
az group create --name $RESOURCE_GROUP --location $LOCATION
```
```

**Example of unsupported command:**
```markdown
```bash
export APP_NAME="myApp"
# This requires elevated Graph API permissions and would fail
az ad app create --display-name $APP_NAME --native-app
```
```

This filter system ensures that you select documentation that can be effectively transformed into executable docs that provide value through automated deployment capabilities. Please reach out to the [Exec Docs Team](#contact-information-for-exec-docs) if you have any questions about the suitability of a document for conversion to an Exec Doc.

## How to Write an Exec Doc

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)_:
Expand Down Expand Up @@ -81,33 +158,14 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
│ └── my-script.yaml
```

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.

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:

- bash
- azurecli
- azure-cli-interactive
- azurecli-interactive

**Example:**

```bash
az group create --name $MY_RESOURCE_GROUP_NAME --location $REGION
```

>**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._

>**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.

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.
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.

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

**Example:**

```markdown
# Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using Azure CLI
# Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using Azure CLI
```

### Writing Requirements
Expand Down Expand Up @@ -299,15 +357,22 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any

**Example:**

**Title:** _Making your Azure Doc executable!_
**Title:** Making your Azure Doc executable!

_**Details:** Hello [author_name], \
\
I am submitting this PR to make the doc you have authored executable! Essentially, without any major content changes, this will make your doc accesssible, accurate, and actionable! And what is "this": Exec Docs (short for Executable Documentation) \
\
Exec Docs are documents that automate the deployment/maintenace of Azure resources using Azure CLI commands. This is a new initiative undertaken by the Azure Core Linux, Skilling, and Portal teams to simplify the evaluation and adoption of services for Linux on Azure customers. [Learn More Here!](https://github.com/MicrosoftDocs/executable-docs/blob/main/README.md)\
\
Once you get acquainted with Exec Docs, I would love to get your review on this doc. If you have any questions feel free to contact me or [Naman Parikh](mailto:[email protected])._
**Details:**

Hello [author_name],

This PR will increase the value of the doc to customers, it turns the doc into an Executable Document! An Executable Document improves the customer experience by making the content actionable in portal as well as ensuring that it works, as documented, using automated testing.

Exec Docs are:
- Fully integrated into Portal where the user can leverage them in hands on learning experiences OR low effort "click to deploy" scenarios
- Increased reusability through adoption of consistent best practices and exportable scripts
- Higher quality as a result of automated testing

We have conducted many experiments and have consistent results that show higher CSAT from customers working with Exec Docs. This in turn results in a higher conversion rate from experimentation to paid customer. [Learn More Here!](https://microsoft-my.sharepoint.com/:p:/p/namanparikh/EdxlQiyhGDhFmGcAUE9fejYB3r6ZzgLqWO3jZPK7fcnKgQ?e=CDWOet)

Once you get acquainted with Exec Docs, I would love to get your review on this doc. If you have any questions feel free to contact me or [Naman Parikh](mailto:[email protected]).

- Assign the original Exec Doc author (if it is not you) as a reviewer to the PR. In most cases, this assignment should happen automatically and should include a reviewer from the Skilling team.
- Add the comment ***#sign-off*** in the PR comments section once the Exec Doc is successfully reviewed. This will trigger the automated pipeline to merge the PR into the public repo.
Expand Down Expand Up @@ -349,12 +414,12 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any

**Deeplink Template:**
```markdown
[![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>)
[![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>)
```

**Deeplink for Example Exec Doc:**
```markdown
[![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)
[![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)
```

**Example of Button in Live Exec Doc:**
Expand Down Expand Up @@ -456,11 +521,10 @@ For the first PR, if either the original doc author or someone from skilling is
## Contact Information for Exec Docs

- PM for Exec Docs E2E Experience: [Naman Parikh](mailto:[email protected])
- PM for Exec Docs Portal Experience: [Varun Desai](mailto:[email protected])
- PM for Innovation Engine: [Mitchell Bifeld](mailto:[email protected])
- Skilling & Content Developer for Exec Docs: [Carol Smith](mailto:[email protected])
- Devs for Exec Docs: [PJ Singh](mailto:[email protected]), [Aria Amini](mailto:[email protected]), [Abhishek Bhombore](mailto:[email protected])
- Devs for Innovation Engine: [Vincenzo Marcella](mailto:[email protected]), [Rahul Gupta](mailto:[email protected])
- PM for Exec Docs Portal Experience: [Matt DePietro]([email protected])
- PM for Innovation Engine: [Ross Gardler](mailto:[email protected])
- MS Learn Point Person: [Carol Smith](mailto:[email protected]), [Rayo Flores](mailto:[email protected]), [Chase Dovey](mailto:[email protected]),
- Devs for Exec Docs: [PJ Singh](mailto:[email protected]), [Aria Amini](mailto:[email protected])

## Trademarks
This project may contain trademarks or logos for projects, products, or
Expand Down
28 changes: 0 additions & 28 deletions azure-vote-nginx-ssl.yml

This file was deleted.

Loading