You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,17 +26,10 @@ I'll update the highlighted section with the clarified information about command
26
26
Not all documentation is suitable for conversion to Exec Docs. Use these filters to determine if a document can be effectively converted:
27
27
28
28
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
-
=======
35
29
-**Supported scenarios:**
36
30
- Any command that can run in a BASH terminal (e.g. azurecli, azure-cli-interactive, azurecli-interactive commands)
37
31
38
32
-**Not supported currently:**
39
-
>>>>>>> 33a7dbee83edb5d5749d591f55071a48c2be6547
40
33
- PowerShell scripts
41
34
- GUI-based instructions
42
35
- Commands requiring `sudo` privileges
@@ -364,15 +357,22 @@ Check if all prerequisites below are met before writing the Exec Doc. ***If any
364
357
365
358
**Example:**
366
359
367
-
**Title:**_Making your Azure Doc executable!_
360
+
**Title:**Making your Azure Doc executable!
368
361
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]).
376
376
377
377
- 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.
378
378
- 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.
0 commit comments