mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-16 15:27:22 +00:00
Merge pull request #3 from doshnid/revert-2-nidos_mcc_working
Revert "mcc ent public preview toc changes"
This commit is contained in:
commit
7cc364cb00
@ -35,30 +35,14 @@
|
||||
items:
|
||||
- name: MCC for Enterprise and Education Overview
|
||||
href: mcc-ent-edu-overview.md
|
||||
- name: How-to guides
|
||||
items:
|
||||
- name: Create MCC resource and cache node
|
||||
href: mcc-ent-create-resource-and-cache.md
|
||||
- name: Configure, provision and deploy cache node
|
||||
items:
|
||||
- name: Configure and provision cache node on Linux
|
||||
href: mcc-ent-configure-provision-linux.md
|
||||
- name: Configure and provision cache node on Windows
|
||||
href: mcc-ent-configure-provision-windows.md
|
||||
- name: Verify cache node functionality
|
||||
href: mcc-ent-verify-cache-node.md
|
||||
- name: Uninstalling cache node
|
||||
href: mcc-ent-unintall-cache-node.md
|
||||
- name: Using CLI to create and manage cache nodes
|
||||
href: mcc-ent-manage-cache-using-CLI.md
|
||||
- name: Resources
|
||||
items:
|
||||
- name: Frequent Asked Questions
|
||||
href: mcc-ent-faq.md
|
||||
- name: Support and troubleshooting
|
||||
href: mcc-ent-support-and-troubleshooting.md
|
||||
- name: MCC for Enterprise and Education (early preview)
|
||||
href: mcc-ent-private-preview.md
|
||||
- name: Requirements
|
||||
href: mcc-enterprise-prerequisites.md
|
||||
- name: Deploy Microsoft Connected Cache
|
||||
href: mcc-enterprise-deploy.md
|
||||
- name: Update or uninstall MCC
|
||||
href: mcc-enterprise-update-uninstall.md
|
||||
- name: Appendix
|
||||
href: mcc-enterprise-appendix.md
|
||||
- name: MCC for ISPs
|
||||
items:
|
||||
- name: MCC for ISPs Overview
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,109 +0,0 @@
|
||||
---
|
||||
title: #Required; "What is <product>?"
|
||||
description: #Required; article description that is displayed in search results.
|
||||
author: #Required; your GitHub user alias, with correct capitalization.
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: overview #Required; leave this attribute/value as-is.
|
||||
ms.date: #Required; mm/dd/yyyy format.
|
||||
|
||||
#CustomerIntent: As a <type of user>, I want <what?> so that <why?>.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the
|
||||
main branch.
|
||||
|
||||
This template provides the basic structure of a Overview article pattern. See the [instructions - Overview](../level4/article-overview.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
Overview is an article pattern that covers two aspects of a product or service:
|
||||
|
||||
* What is it?
|
||||
* What is it used for?
|
||||
|
||||
An Overview article talks about the product or service from a technical point of view. It's not intended to define the benefits or value proposition. That just duplicates marketing.
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: This is the primary heading at the top of the article.
|
||||
|
||||
Use the format "What is <service>?"
|
||||
|
||||
You can also use this in the TOC if your service name doesn’t cause the phrase to wrap.
|
||||
|
||||
-->
|
||||
|
||||
# What is <product/service>?
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes what the article covers. Answer the fundamental “why would I want to know this?” question. Keep it short.
|
||||
|
||||
Many services add artwork or videos below the Introduction.
|
||||
|
||||
-->
|
||||
|
||||
[Introductory paragraph]
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info
|
||||
directly into the article text.
|
||||
|
||||
--->
|
||||
|
||||
<!-- 3. H2s (Article body)------------------------------------------------------------
|
||||
|
||||
Required: The article body should discuss the features that answer the "Why should I care?" question with a bit more depth.
|
||||
|
||||
Give each H2 a heading that sets expectations for the content that follows.
|
||||
Follow the H2 headings with a sentence about how the section contributes to the whole.
|
||||
Add images, code blocks, or other graphical elements after the information it illustrates.
|
||||
|
||||
* Call out any basic requirements and dependencies.
|
||||
* Call out limitations or overhead.
|
||||
* Don't catalog every feature. Some might only need to be mentioned as available, without any discussion.
|
||||
* Give each H2 a heading that sets expectations for the content that follows.
|
||||
* Follow the H2 headings with a sentence about how the section contributes to the whole.
|
||||
* Images, code blocks, or other graphical elements come after the text block it illustrates.
|
||||
Don't number H2s.
|
||||
|
||||
-->
|
||||
|
||||
## [Section 1 heading]
|
||||
TODO: add your content
|
||||
|
||||
## [Section 2 heading]
|
||||
TODO: add your content
|
||||
|
||||
## [Section n heading]
|
||||
TODO: add your content
|
||||
|
||||
<!-- 4. Next step/Related content ------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
@ -1,143 +0,0 @@
|
||||
---
|
||||
title: #Required; "<verb> * <noun>"
|
||||
description: #Required; Keep the description within 100- and 165-characters including spaces.
|
||||
author: #Required; your GitHub user alias, with correct capitalization
|
||||
ms.author: #Required; microsoft alias of author
|
||||
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
|
||||
ms.topic: how-to #Required; leave this attribute/value as-is
|
||||
ms.date: #Required; mm/dd/yyyy format
|
||||
|
||||
#CustomerIntent: As a < type of user >, I want < what? > so that < why? >.
|
||||
---
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
|
||||
This template provides the basic structure of a How-to article pattern. See the
|
||||
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
|
||||
|
||||
You can provide feedback about this template at: https://aka.ms/patterns-feedback
|
||||
|
||||
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 1. H1 -----------------------------------------------------------------------------
|
||||
|
||||
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
|
||||
|
||||
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
|
||||
|
||||
* Include only a single H1 in the article.
|
||||
* Don't start with a gerund.
|
||||
* Don't include "Tutorial" in the H1.
|
||||
|
||||
-->
|
||||
|
||||
# "<verb> * <noun>"
|
||||
TODO: Add your heading
|
||||
|
||||
<!-- 2. Introductory paragraph ----------------------------------------------------------
|
||||
|
||||
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
|
||||
|
||||
Readers should have a clear idea of what they will do in this article after reading the introduction.
|
||||
|
||||
* Introduction immediately follows the H1 text.
|
||||
* Introduction section should be between 1-3 paragraphs.
|
||||
* Don't use a bulleted list of article H2 sections.
|
||||
|
||||
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
|
||||
|
||||
-->
|
||||
|
||||
TODO: Add your introductory paragraph
|
||||
|
||||
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
|
||||
|
||||
-->
|
||||
|
||||
<!-- 3. Prerequisites --------------------------------------------------------------------
|
||||
|
||||
Required: Make Prerequisites the first H2 after the H1.
|
||||
|
||||
* Provide a bulleted list of items that the user needs.
|
||||
* Omit any preliminary text to the list.
|
||||
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
|
||||
|
||||
-->
|
||||
|
||||
## Prerequisites
|
||||
|
||||
TODO: List the prerequisites
|
||||
|
||||
<!-- 4. Task H2s ------------------------------------------------------------------------------
|
||||
|
||||
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
|
||||
|
||||
For portal-based procedures, minimize bullets and numbering.
|
||||
|
||||
* Each H2 should be a major step in the task.
|
||||
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
|
||||
* Don't start with a gerund.
|
||||
* Don't number the H2s.
|
||||
* Begin each H2 with a brief explanation for context.
|
||||
* Provide a ordered list of procedural steps.
|
||||
* Provide a code block, diagram, or screenshot if appropriate
|
||||
* An image, code block, or other graphical element comes after numbered step it illustrates.
|
||||
* If necessary, optional groups of steps can be added into a section.
|
||||
* If necessary, alternative groups of steps can be added into a section.
|
||||
|
||||
-->
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
## "\<verb\> * \<noun\>"
|
||||
TODO: Add introduction sentence(s)
|
||||
[Include a sentence or two to explain only what is needed to complete the procedure.]
|
||||
TODO: Add ordered list of procedure steps
|
||||
1. Step 1
|
||||
1. Step 2
|
||||
1. Step 3
|
||||
|
||||
<!-- 5. Next step/Related content------------------------------------------------------------------------
|
||||
|
||||
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
|
||||
- For Next step, provide one link to the next step in a sequence. Use the blue box format
|
||||
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
|
||||
|
||||
-->
|
||||
|
||||
## Next step
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
> [!div class="nextstepaction"]
|
||||
> [Write concepts](article-concept.md)
|
||||
|
||||
<!-- OR -->
|
||||
|
||||
## Related content
|
||||
|
||||
TODO: Add your next step link(s)
|
||||
|
||||
- [Write concepts](article-concept.md)
|
||||
|
||||
<!--
|
||||
Remove all the comments in this template before you sign-off or merge to the main branch.
|
||||
-->
|
||||
|
Loading…
x
Reference in New Issue
Block a user