Skip to content

Commit e8abd9e

Browse files
author
naman-msft
committed
Merge branch 'main' of github.com:MicrosoftDocs/executable-docs into test_all
2 parents 135cc9f + 682114f commit e8abd9e

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,10 @@ I'll update the highlighted section with the clarified information about command
2626
Not all documentation is suitable for conversion to Exec Docs. Use these filters to determine if a document can be effectively converted:
2727

2828
1. **Command Execution Limitations**
29-
<<<<<<< HEAD
30-
- **Supported:**
31-
- Any command that can run in a BASH terminal (e.g. azurecli, azure-cli-interactive, azurecli-interactive commands)
32-
33-
- **Not supported:**
34-
=======
3529
- **Supported scenarios:**
3630
- Any command that can run in a BASH terminal (e.g. azurecli, azure-cli-interactive, azurecli-interactive commands)
3731

3832
- **Not supported currently:**
39-
>>>>>>> 33a7dbee83edb5d5749d591f55071a48c2be6547
4033
- PowerShell scripts
4134
- GUI-based instructions
4235
- Commands requiring `sudo` privileges
@@ -364,15 +357,22 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
364357

365358
**Example:**
366359

367-
**Title:** _Making your Azure Doc executable!_
360+
**Title:** Making your Azure Doc executable!
368361

369-
_**Details:** Hello [author_name], \
370-
\
371-
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) \
372-
\
373-
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)\
374-
\
375-
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])._
362+
**Details:**
363+
364+
Hello [author_name],
365+
366+
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.
367+
368+
Exec Docs are:
369+
- Fully integrated into Portal where the user can leverage them in hands on learning experiences OR low effort "click to deploy" scenarios
370+
- Increased reusability through adoption of consistent best practices and exportable scripts
371+
- Higher quality as a result of automated testing
372+
373+
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)
374+
375+
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]).
376376

377377
- 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.
378378
- 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.
@@ -521,11 +521,10 @@ For the first PR, if either the original doc author or someone from skilling is
521521
## Contact Information for Exec Docs
522522
523523
- PM for Exec Docs E2E Experience: [Naman Parikh](mailto:[email protected])
524-
- PM for Exec Docs Portal Experience: [Varun Desai](mailto:[email protected])
525-
- PM for Innovation Engine: [Mitchell Bifeld](mailto:[email protected])
526-
- Skilling & Content Developer for Exec Docs: [Carol Smith](mailto:[email protected])
527-
- Devs for Exec Docs: [PJ Singh](mailto:[email protected]), [Aria Amini](mailto:[email protected]), [Abhishek Bhombore](mailto:[email protected])
528-
- Devs for Innovation Engine: [Vincenzo Marcella](mailto:[email protected]), [Rahul Gupta](mailto:[email protected])
524+
- PM for Exec Docs Portal Experience: [Matt DePietro]([email protected])
525+
- PM for Innovation Engine: [Ross Gardler](mailto:[email protected])
526+
- MS Learn Point Person: [Carol Smith](mailto:[email protected]), [Rayo Flores](mailto:[email protected]), [Chase Dovey](mailto:[email protected]),
527+
- Devs for Exec Docs: [PJ Singh](mailto:[email protected]), [Aria Amini](mailto:[email protected])
529528
530529
## Trademarks
531530
This project may contain trademarks or logos for projects, products, or

0 commit comments

Comments
 (0)