Microsoft/alguidelines
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

deploy: ea9d99f3bb

Browse source
This commit is contained in:
TheDoubleH 2022-02-22 08:03:05 +00:00
parent 8653165eed
commit 573b8d1ca3
192 changed files with 1919 additions and 1819 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/contributing/forkandpr/index.html
View file

@ -62,7 +62,7 @@ If You are toying with an idea, but You aren’t ready to create a document
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -73,7 +73,7 @@ If You are toying with an idea, but You aren&rsquo;t ready to create a document
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -470,17 +470,17 @@ If You are toying with an idea, but You aren&rsquo;t ready to create a document
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span class=td-sidebar-nav-active-item>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -524,8 +524,8 @@ If You are toying with an idea, but You aren&rsquo;t ready to create a document
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>

20
docs/contributing/formattingtips/index.html
View file

@ -63,7 +63,7 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -74,7 +74,7 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -471,17 +471,17 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span class=td-sidebar-nav-active-item>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -526,8 +526,8 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>

24
docs/contributing/index.html
View file

@ -55,7 +55,7 @@
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -66,7 +66,7 @@
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -463,17 +463,17 @@
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -505,8 +505,8 @@
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>
@ -558,13 +558,13 @@
</div>
<div class=entry>
<h5>
<a href=/docs/contributing/templates/>Templates</a>
<a href=/docs/contributing/theapprovalprocess/>Understanding the Approval Process</a>
</h5>
<p></p>
</div>
<div class=entry>
<h5>
<a href=/docs/contributing/theapprovalprocess/>Understanding the Approval Process</a>
<a href=/docs/contributing/templates/>Templates</a>
</h5>
<p></p>
</div>

16
docs/contributing/index.xml
View file

@ -87,12 +87,12 @@ If You haven&amp;rsquo;t worked in collaboration with &amp;ldquo;external&amp;rd
&lt;p>Once you are happy with your contribution, it&amp;rsquo;s time to create a pull request to propose changes into the main project! This is the final step in producing a fork of someone else&amp;rsquo;s project, and arguably the most important. If you&amp;rsquo;ve made a change that you feel would benefit the community as a whole, you should definitely consider contributing back.&lt;/p>
&lt;p>To do so, head on over to the repository on GitHub where your project lives. For this example, it would be at &lt;code>https://www.github.com/&amp;lt;your_username&amp;gt;/alguidelines&lt;/code>. You&amp;rsquo;ll see a banner indicating that your branch is one commit ahead of microsoft:main. Click &lt;strong>Contribute&lt;/strong> and then &lt;strong>Open a pull request.&lt;/strong>&lt;/p>
&lt;p>GitHub will bring you to a page that shows the differences between your fork and the microsoft/alguidelines repository. Click &lt;strong>Create pull request.&lt;/strong>&lt;/p>
&lt;p>GitHub will bring you to a page where you can enter a title and a description of your changes. &lt;em>It&amp;rsquo;s important to provide as much useful information and a rationale for why you&amp;rsquo;re making this pull request in the first place.&lt;/em> The project owners needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click &lt;strong>Create pull request.&lt;/strong>&lt;/p></description></item><item><title>Docs: Templates</title><link>https://alguidelines.dev/docs/contributing/templates/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/</guid><description>
&lt;h1 id="templates">Templates&lt;/h1>
&lt;p>We have foreseen some template-files that you can simply copy and use. Look at them as &amp;ldquo;Patterns for describing patterns&amp;rdquo; 😉.&lt;/p>
&lt;p>We have foreseen a Template:&lt;/p>
&lt;p>GitHub will bring you to a page where you can enter a title and a description of your changes. &lt;em>It&amp;rsquo;s important to provide as much useful information and a rationale for why you&amp;rsquo;re making this pull request in the first place.&lt;/em> The project owners needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click &lt;strong>Create pull request.&lt;/strong>&lt;/p></description></item><item><title>Docs: Understanding the Approval Process</title><link>https://alguidelines.dev/docs/contributing/theapprovalprocess/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/theapprovalprocess/</guid><description>
&lt;p>(coming soon)&lt;/p></description></item><item><title>Docs: Templates</title><link>https://alguidelines.dev/docs/contributing/templates/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/</guid><description>
&lt;p>We have created some template-files that you can simply copy and use. Look at them as &amp;ldquo;Patterns for describing patterns&amp;rdquo;&lt;/p>
&lt;p>We currently offer the following templates:&lt;/p>
&lt;ul>
&lt;li>for &lt;a href="https://alguidelines.dev/contributing/templates/patterns/">patterns&lt;/a>&lt;/li>
&lt;li>for &lt;a href="https://alguidelines.dev/contributing/templates/guidelines/">guidelines&lt;/a>&lt;/li>
&lt;/ul></description></item><item><title>Docs: Understanding the Approval Process</title><link>https://alguidelines.dev/docs/contributing/theapprovalprocess/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/theapprovalprocess/</guid><description>
&lt;p>(coming soon)&lt;/p></description></item></channel></rss>
&lt;li>for &lt;a href="https://alguidelines.dev/contributing/templates/patterns/">Patterns&lt;/a> (&lt;a href="https://raw.githubusercontent.com/microsoft/alguidelines/main/content/docs/Contributing/Templates/Patterns/index.md">raw&lt;/a>)&lt;/li>
&lt;li>for &lt;a href="https://alguidelines.dev/contributing/templates/bestpractice/">Best Practice&lt;/a> (&lt;a href="https://raw.githubusercontent.com/microsoft/alguidelines/main/content/docs/Contributing/Templates/BestPractice/index.md">raw&lt;/a>)&lt;/li>
&lt;/ul>
&lt;p>opening the &amp;ldquo;raw&amp;rdquo; link, will allow for the best copy/paste result.&lt;/p></description></item></channel></rss>

92
docs/contributing/templates/guidelines/index.html → docs/contributing/templates/bestpractice/index.html
View file

@ -14,31 +14,35 @@
<link rel=icon type=image/png href=/favicons/android-96x96.png sizes=96x96>
<link rel=icon type=image/png href=/favicons/android-144x144.png sizes=144x144>
<link rel=icon type=image/png href=/favicons/android-192x192.png sizes=192x192>
<title>Title of the Guideline | alguidelines.dev - Business Central Design Patterns</title>
<meta name=description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by …">
<meta property="og:title" content="Title of the Guideline">
<meta property="og:description" content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<title>Title Here | alguidelines.dev - Business Central Design Patterns</title>
<meta name=description content="
Created by Described by
Description
In depth description on what this Pattern is all about
basic components
how the interact
steps to implement …</!--></!-->">
<meta property="og:title" content="Title Here">
<meta property="og:description" content="Created by Described by
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions <Please replace the &ldquo;TITLEOFYOURGUIDELINEGOESHERE&rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &ldquo;space&rdquo; replaced by a &ldquo;+&#34;) - and remove this line.">
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions Please discuss this guideline You can find discussions on all &ldquo;Best Practices&rdquo; here.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://alguidelines.dev/docs/contributing/templates/guidelines/"><meta property="og:image" content="https://alguidelines.dev/images/og-image-fission.png"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2022-02-20T20:58:53+01:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="Title of the Guideline">
<meta itemprop=description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<meta property="og:url" content="https://alguidelines.dev/docs/contributing/templates/bestpractice/"><meta property="og:image" content="https://alguidelines.dev/images/og-image-fission.png"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2022-02-21T22:57:39-08:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="Title Here">
<meta itemprop=description content="Created by Described by
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions <Please replace the &ldquo;TITLEOFYOURGUIDELINEGOESHERE&rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &ldquo;space&rdquo; replaced by a &ldquo;+&#34;) - and remove this line.">
<meta itemprop=dateModified content="2022-02-20T20:58:53+01:00">
<meta itemprop=wordCount content="108"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions Please discuss this guideline You can find discussions on all &ldquo;Best Practices&rdquo; here.">
<meta itemprop=dateModified content="2022-02-21T22:57:39-08:00">
<meta itemprop=wordCount content="46"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
<meta itemprop=keywords content><meta name=twitter:card content="summary_large_image">
<meta name=twitter:image content="https://alguidelines.dev/images/og-image-fission.png">
<meta name=twitter:title content="Title of the Guideline">
<meta name=twitter:description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<meta name=twitter:title content="Title Here">
<meta name=twitter:description content="Created by Described by
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions <Please replace the &ldquo;TITLEOFYOURGUIDELINEGOESHERE&rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &ldquo;space&rdquo; replaced by a &ldquo;+&#34;) - and remove this line.">
basic components how the interact steps to implement considerations to take Bad code PutCodeblocksHere() Good code PutCodeblocksHere() Discussions Please discuss this guideline You can find discussions on all &ldquo;Best Practices&rdquo; here.">
<link rel=preload href=/scss/main.min.465d5fa0bd58415aee47bc5a1c5d8deee19fe158cff814bc698ee863ea6b68eb.css as=style>
<link href=/scss/main.min.465d5fa0bd58415aee47bc5a1c5d8deee19fe158cff814bc698ee863ea6b68eb.css rel=stylesheet integrity>
<script src=https://code.jquery.com/jquery-3.6.0.min.js integrity=sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK crossorigin=anonymous></script>
@ -68,7 +72,7 @@ Description In depth description on what this Pattern is all about
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -79,7 +83,7 @@ Description In depth description on what this Pattern is all about
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -476,17 +480,17 @@ Description In depth description on what this Pattern is all about
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span class=td-sidebar-nav-active-item>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span class=td-sidebar-nav-active-item>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -498,10 +502,10 @@ Description In depth description on what this Pattern is all about
</aside>
<aside class="d-none d-xl-block col-xl-2 td-sidebar-toc d-print-none">
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
<a href=https://github.com/microsoft/alguidelines/tree/main/content/docs/Contributing/Templates/Guidelines/index.md class=td-page-meta--view target=_blank rel=noopener><i class="fa fa-file-alt fa-fw"></i> View page source</a>
<a href=https://github.com/microsoft/alguidelines/edit/main/content/docs/Contributing/Templates/Guidelines/index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/microsoft/alguidelines/new/main/content/docs/Contributing/Templates/Guidelines/index.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" class=td-page-meta--child target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Create child page</a>
<a href="https://github.com/microsoft/alguidelines/issues/new?title=Title%20of%20the%20Guideline" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/microsoft/alguidelines/tree/main/content/docs/Contributing/Templates/BestPractice/index.md class=td-page-meta--view target=_blank rel=noopener><i class="fa fa-file-alt fa-fw"></i> View page source</a>
<a href=https://github.com/microsoft/alguidelines/edit/main/content/docs/Contributing/Templates/BestPractice/index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/microsoft/alguidelines/new/main/content/docs/Contributing/Templates/BestPractice/index.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" class=td-page-meta--child target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Create child page</a>
<a href="https://github.com/microsoft/alguidelines/issues/new?title=Title%20Here" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/microsoft/alguidelines/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
</div>
<div class=td-toc><nav id=TableOfContents>
@ -509,7 +513,7 @@ Description In depth description on what this Pattern is all about
<li><a href=#description>Description</a></li>
<li><a href=#bad-code>Bad code</a></li>
<li><a href=#good-code>Good code</a></li>
<li><a href=#discussionshttpsgithubcommicrosoftalguidelinesdiscussionscategoriesbc-best-practicesdiscussions_qtitleofyourguidelinegoesherecategory3a22bcbestpractices22><a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=TITLEOFYOURGUIDELINEGOESHERE+category%3A%22BC+Best+Practices%22">Discussions</a></a></li>
<li><a href=#discussions>Discussions</a></li>
</ul>
</nav></div>
<div class="taxonomy taxonomy-terms-cloud taxo-tags">
@ -526,8 +530,8 @@ Description In depth description on what this Pattern is all about
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>
@ -544,16 +548,21 @@ Description In depth description on what this Pattern is all about
<a href=https://alguidelines.dev/docs/contributing/templates/>Templates</a>
</li>
<li class="breadcrumb-item active" aria-current=page>
<a href=https://alguidelines.dev/docs/contributing/templates/guidelines/>Title of the Guideline</a>
<a href=https://alguidelines.dev/docs/contributing/templates/bestpractice/>Title Here</a>
</li>
</ol>
</nav>
<div class=td-content>
<h1>Title of the Guideline</h1>
<h1>Title Here</h1>
<header class=article-meta>
<div class="taxonomy taxonomy-terms-article taxo-categories">
<h5 class=taxonomy-title>Categories:</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span></a></li>
</ul>
</div>
</header>
<p>This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).</p>
<p>&lt;<em>Created by (company), Described by (company)</em>></p>
<p><em>Created by Described by </em></p>
<h2 id=description>Description</h2>
<p>In depth description on what this Pattern is all about</p>
<ul>
@ -566,12 +575,11 @@ Description In depth description on what this Pattern is all about
<div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al>PutCodeblocksHere<span style=color:#ce5c00;font-weight:700>()
</span></code></pre></div><h2 id=good-code>Good code</h2>
<div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-al data-lang=al>PutCodeblocksHere<span style=color:#ce5c00;font-weight:700>()
</span></code></pre></div><h2 id=discussionshttpsgithubcommicrosoftalguidelinesdiscussionscategoriesbc-best-practicesdiscussions_qtitleofyourguidelinegoesherecategory3a22bcbestpractices22><a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=TITLEOFYOURGUIDELINEGOESHERE+category%3A%22BC+Best+Practices%22">Discussions</a></h2>
<p>&lt;Please replace the &ldquo;TITLEOFYOURGUIDELINEGOESHERE&rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &ldquo;space&rdquo; replaced by a &ldquo;+") - and remove this line. ></p>
</span></code></pre></div><h2 id=discussions>Discussions</h2>
<p>Please discuss this guideline </p>
<p>You can find discussions on all &ldquo;Best Practices&rdquo; <a href=https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices>here</a>.</p>
<p>If you don&rsquo;t find the discussion of this guideline, please feel free to create a new one with the same title as this article.</p>
<div class="text-muted mt-5 pt-3 border-top">
Last modified February 20, 2022: <a href=https://github.com/microsoft/alguidelines/commit/3d0cb3a40bf1b3ca00d2c10d7a977e2a806818e3>Moving contributing (3d0cb3a4)</a>
Last modified February 21, 2022: <a href=https://github.com/microsoft/alguidelines/commit/22bceb14842a63d98699b2f26e7cb481bb38ce22>Update Templates for Docsy and synced them up (22bceb14)</a>
</div>
</div>
</main>

41
docs/contributing/templates/index.html
View file

@ -16,9 +16,8 @@
<link rel=icon type=image/png href=/favicons/android-144x144.png sizes=144x144>
<link rel=icon type=image/png href=/favicons/android-192x192.png sizes=192x192>
<title>Templates | alguidelines.dev - Business Central Design Patterns</title>
<meta name=description content="Templates
We have foreseen some template-files that you can simply copy and use. Look at them as &ldquo;Patterns for describing patterns&rdquo; 😉.
We …">
<meta name=description content="We have created some template-files that you can simply copy and use. Look at them as &ldquo;Patterns for describing patterns&rdquo;
We currently …">
<meta property="og:title" content="Templates">
<meta property="og:description" content="Guidelines for when Developing AL for Microsoft Dynamics 365 Business Central">
<meta property="og:type" content="website">
@ -57,7 +56,7 @@ We …">
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -68,7 +67,7 @@ We …">
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -465,17 +464,17 @@ We …">
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span class=td-sidebar-nav-active-item>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -507,8 +506,8 @@ We …">
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>
@ -530,30 +529,30 @@ We …">
<h1>Templates</h1>
<header class=article-meta>
</header>
<h1 id=templates>Templates</h1>
<p>We have foreseen some template-files that you can simply copy and use. Look at them as &ldquo;Patterns for describing patterns&rdquo; 😉.</p>
<p>We have foreseen a Template:</p>
<p>We have created some template-files that you can simply copy and use. Look at them as &ldquo;Patterns for describing patterns&rdquo;</p>
<p>We currently offer the following templates:</p>
<ul>
<li>for <a href=/contributing/templates/patterns/>patterns</a></li>
<li>for <a href=/contributing/templates/guidelines/>guidelines</a></li>
<li>for <a href=/contributing/templates/patterns/>Patterns</a> (<a href=https://raw.githubusercontent.com/microsoft/alguidelines/main/content/docs/Contributing/Templates/Patterns/index.md>raw</a>)</li>
<li>for <a href=/contributing/templates/bestpractice/>Best Practice</a> (<a href=https://raw.githubusercontent.com/microsoft/alguidelines/main/content/docs/Contributing/Templates/BestPractice/index.md>raw</a>)</li>
</ul>
<p>opening the &ldquo;raw&rdquo; link, will allow for the best copy/paste result.</p>
<div class=section-index>
<hr class=panel-line>
<div class=entry>
<h5>
<a href=/docs/contributing/templates/guidelines/>Title of the Guideline</a>
<a href=/docs/contributing/templates/patterns/>Pattern Name</a>
</h5>
<p></p>
</div>
<div class=entry>
<h5>
<a href=/docs/contributing/templates/patterns/>Title of the pattern</a>
<a href=/docs/contributing/templates/bestpractice/>Title Here</a>
</h5>
<p></p>
</div>
</div>
<div class="text-muted mt-5 pt-3 border-top">
Last modified February 20, 2022: <a href=https://github.com/microsoft/alguidelines/commit/3d0cb3a40bf1b3ca00d2c10d7a977e2a806818e3>Moving contributing (3d0cb3a4)</a>
Last modified February 21, 2022: <a href=https://github.com/microsoft/alguidelines/commit/eb783b94ff074295be3294b280f59dccffe02981>Cleanup and fix link (eb783b94)</a>
</div>
</div>
</main>

47
docs/contributing/templates/index.xml
View file

@ -1,24 +1,6 @@
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>alguidelines.dev - Business Central Design Patterns – Templates</title><link>https://alguidelines.dev/docs/contributing/templates/</link><description>Recent content in Templates on alguidelines.dev - Business Central Design Patterns</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://alguidelines.dev/docs/contributing/templates/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Title of the Guideline</title><link>https://alguidelines.dev/docs/contributing/templates/guidelines/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/guidelines/</guid><description>
&lt;p>This is a guideline, some parts are optional (if there&amp;rsquo;s no content, remove the whole paragraph).&lt;/p>
&lt;p>&amp;lt;&lt;em>Created by (company), Described by (company)&lt;/em>&amp;gt;&lt;/p>
&lt;h2 id="description">Description&lt;/h2>
&lt;p>In depth description on what this Pattern is all about&lt;/p>
&lt;ul>
&lt;li>basic components&lt;/li>
&lt;li>how the interact&lt;/li>
&lt;li>steps to implement&lt;/li>
&lt;li>considerations to take&lt;/li>
&lt;/ul>
&lt;h2 id="bad-code">Bad code&lt;/h2>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4">&lt;code class="language-al" data-lang="al">PutCodeblocksHere&lt;span style="color:#ce5c00;font-weight:bold">()
&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="good-code">Good code&lt;/h2>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4">&lt;code class="language-al" data-lang="al">PutCodeblocksHere&lt;span style="color:#ce5c00;font-weight:bold">()
&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="discussionshttpsgithubcommicrosoftalguidelinesdiscussionscategoriesbc-best-practicesdiscussions_qtitleofyourguidelinegoesherecategory3a22bcbestpractices22">&lt;a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=TITLEOFYOURGUIDELINEGOESHERE+category%3A%22BC+Best+Practices%22">Discussions&lt;/a>&lt;/h2>
&lt;p>&amp;lt;Please replace the &amp;ldquo;TITLEOFYOURGUIDELINEGOESHERE&amp;rdquo; in the link above, with the Title+of+the+Guideline (indeed, with &amp;ldquo;space&amp;rdquo; replaced by a &amp;ldquo;+&amp;quot;) - and remove this line. &amp;gt;&lt;/p>
&lt;p>You can find discussions on all &amp;ldquo;Best Practices&amp;rdquo; &lt;a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices">here&lt;/a>.&lt;/p>
&lt;p>If you don&amp;rsquo;t find the discussion of this guideline, please feel free to create a new one with the same title as this article.&lt;/p></description></item><item><title>Docs: Title of the pattern</title><link>https://alguidelines.dev/docs/contributing/templates/patterns/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/patterns/</guid><description>
&lt;p>This is a guideline, some parts are optional (if there&amp;rsquo;s no content, remove the whole paragraph).&lt;/p>
&lt;p>&amp;lt;&lt;em>Created by (company), Described by (company)&lt;/em>&amp;gt;&lt;/p>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>alguidelines.dev - Business Central Design Patterns – Templates</title><link>https://alguidelines.dev/docs/contributing/templates/</link><description>Recent content in Templates on alguidelines.dev - Business Central Design Patterns</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://alguidelines.dev/docs/contributing/templates/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Pattern Name</title><link>https://alguidelines.dev/docs/contributing/templates/patterns/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/patterns/</guid><description>
&lt;!-- This is a guideline, some parts are optional (if there's no content, remove the whole paragraph). -->
&lt;p>&lt;em>Created by &lt;!-- John Smith -->&lt;!--, Cronus International.--> Described by &lt;!-- Jane Doe-->&lt;!--, Contoso, LLC-->&lt;/em>&lt;/p>
&lt;h2 id="abstract">Abstract&lt;/h2>
&lt;p>Short, descriptive and easy to remember description of this pattern.&lt;/p>
&lt;h2 id="context">Context&lt;/h2>
@ -42,4 +24,25 @@
&lt;h2 id="list-of-references">List of references&lt;/h2>
&lt;p>Youtube-link? BaseApp? Tweet? &amp;hellip;&lt;/p>
&lt;h2 id="discussions">Discussions&lt;/h2>
&lt;p>Create a discussions-page of your pattern, and add the sentence &amp;ldquo;You can discuss this pattern &lt;a href="https://github.com/microsoft/alguidelines/discussions/42">here&lt;/a>&amp;rdquo; with the right link to that discussions-page.&lt;/p></description></item></channel></rss>
&lt;p>Please discuss this guideline &lt;!--[here](https://github.com/microsoft/alguidelines/discussions/42) Fix the link -->&lt;/p>
&lt;p>You can find discussions on all &amp;ldquo;Best Practices&amp;rdquo; &lt;a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-patterns">here&lt;/a>.&lt;/p>
&lt;!-- Create a discussions-page of your pattern, and add the sentence "You can discuss this pattern [here](https://github.com/microsoft/alguidelines/discussions/42)" with the right link to that discussions-page. --></description></item><item><title>Docs: Title Here</title><link>https://alguidelines.dev/docs/contributing/templates/bestpractice/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://alguidelines.dev/docs/contributing/templates/bestpractice/</guid><description>
&lt;!-- This is a guideline, some parts are optional (if there's no content, remove the whole paragraph). -->
&lt;!-- The "Readability" and "Performance" tags are often used. You can, however, add multiple tags, but please do not change the Category -->
&lt;p>&lt;em>Created by &lt;!-- John Smith -->&lt;!--, Cronus International.--> Described by &lt;!-- Jane Doe-->&lt;!--, Contoso, LLC-->&lt;/em>&lt;/p>
&lt;h2 id="description">Description&lt;/h2>
&lt;p>In depth description on what this Pattern is all about&lt;/p>
&lt;ul>
&lt;li>basic components&lt;/li>
&lt;li>how the interact&lt;/li>
&lt;li>steps to implement&lt;/li>
&lt;li>considerations to take&lt;/li>
&lt;/ul>
&lt;h2 id="bad-code">Bad code&lt;/h2>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4">&lt;code class="language-al" data-lang="al">PutCodeblocksHere&lt;span style="color:#ce5c00;font-weight:bold">()
&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="good-code">Good code&lt;/h2>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4">&lt;code class="language-al" data-lang="al">PutCodeblocksHere&lt;span style="color:#ce5c00;font-weight:bold">()
&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="discussions">Discussions&lt;/h2>
&lt;p>Please discuss this guideline &lt;!--[here](https://github.com/microsoft/alguidelines/discussions/42) Fix the link -->&lt;/p>
&lt;p>You can find discussions on all &amp;ldquo;Best Practices&amp;rdquo; &lt;a href="https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices">here&lt;/a>.&lt;/p>
&lt;!-- Create a discussions-page of your pattern, and add the sentence "You can discuss this pattern [here](https://github.com/microsoft/alguidelines/discussions/42)" with the right link to that discussions-page. --></description></item></channel></rss>

80
docs/contributing/templates/patterns/index.html
View file

@ -14,37 +14,41 @@
<link rel=icon type=image/png href=/favicons/android-96x96.png sizes=96x96>
<link rel=icon type=image/png href=/favicons/android-144x144.png sizes=144x144>
<link rel=icon type=image/png href=/favicons/android-192x192.png sizes=192x192>
<title>Title of the pattern | alguidelines.dev - Business Central Design Patterns</title>
<meta name=description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by …">
<meta property="og:title" content="Title of the pattern">
<meta property="og:description" content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<title>Pattern Name | alguidelines.dev - Business Central Design Patterns</title>
<meta name=description content="
Created by Described by
Abstract
Short, descriptive and easy to remember description of this pattern.
Context
Sets the stage where the pattern …</!-->">
<meta property="og:title" content="Pattern Name">
<meta property="og:description" content="Created by Described by
Abstract Short, descriptive and easy to remember description of this pattern.
Context Sets the stage where the pattern takes place. 1-2 sentences.
Problem What happens before this pattern is used? How can it go wrong? 1-5 lines.
Description In depth description on what this Pattern is all about">
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Usage If applicable: where is it used in an app.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://alguidelines.dev/docs/contributing/templates/patterns/"><meta property="og:image" content="https://alguidelines.dev/images/og-image-fission.png"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2022-02-20T20:58:53+01:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="Title of the pattern">
<meta itemprop=description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<meta property="article:modified_time" content="2022-02-21T22:57:39-08:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="Pattern Name">
<meta itemprop=description content="Created by Described by
Abstract Short, descriptive and easy to remember description of this pattern.
Context Sets the stage where the pattern takes place. 1-2 sentences.
Problem What happens before this pattern is used? How can it go wrong? 1-5 lines.
Description In depth description on what this Pattern is all about">
<meta itemprop=dateModified content="2022-02-20T20:58:53+01:00">
<meta itemprop=wordCount content="163"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Usage If applicable: where is it used in an app.">
<meta itemprop=dateModified content="2022-02-21T22:57:39-08:00">
<meta itemprop=wordCount content="135"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
<meta itemprop=keywords content><meta name=twitter:card content="summary_large_image">
<meta name=twitter:image content="https://alguidelines.dev/images/og-image-fission.png">
<meta name=twitter:title content="Title of the pattern">
<meta name=twitter:description content="This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).
<Created by (company), Described by (company)>
<meta name=twitter:title content="Pattern Name">
<meta name=twitter:description content="Created by Described by
Abstract Short, descriptive and easy to remember description of this pattern.
Context Sets the stage where the pattern takes place. 1-2 sentences.
Problem What happens before this pattern is used? How can it go wrong? 1-5 lines.
Description In depth description on what this Pattern is all about">
Description In depth description on what this Pattern is all about
basic components how the interact steps to implement considerations to take Usage If applicable: where is it used in an app.">
<link rel=preload href=/scss/main.min.465d5fa0bd58415aee47bc5a1c5d8deee19fe158cff814bc698ee863ea6b68eb.css as=style>
<link href=/scss/main.min.465d5fa0bd58415aee47bc5a1c5d8deee19fe158cff814bc698ee863ea6b68eb.css rel=stylesheet integrity>
<script src=https://code.jquery.com/jquery-3.6.0.min.js integrity=sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK crossorigin=anonymous></script>
@ -74,7 +78,7 @@ Description In depth description on what this Pattern is all about">
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -85,7 +89,7 @@ Description In depth description on what this Pattern is all about">
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -482,17 +486,17 @@ Description In depth description on what this Pattern is all about">
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child active-path" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span class=td-sidebar-nav-active-item>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span class=td-sidebar-nav-active-item>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -507,7 +511,7 @@ Description In depth description on what this Pattern is all about">
<a href=https://github.com/microsoft/alguidelines/tree/main/content/docs/Contributing/Templates/Patterns/index.md class=td-page-meta--view target=_blank rel=noopener><i class="fa fa-file-alt fa-fw"></i> View page source</a>
<a href=https://github.com/microsoft/alguidelines/edit/main/content/docs/Contributing/Templates/Patterns/index.md class=td-page-meta--edit target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Edit this page</a>
<a href="https://github.com/microsoft/alguidelines/new/main/content/docs/Contributing/Templates/Patterns/index.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" class=td-page-meta--child target=_blank rel=noopener><i class="fa fa-edit fa-fw"></i> Create child page</a>
<a href="https://github.com/microsoft/alguidelines/issues/new?title=Title%20of%20the%20pattern" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href="https://github.com/microsoft/alguidelines/issues/new?title=Pattern%20Name" class=td-page-meta--issue target=_blank rel=noopener><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
<a href=https://github.com/microsoft/alguidelines/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
</div>
<div class=td-toc><nav id=TableOfContents>
@ -537,8 +541,8 @@ Description In depth description on what this Pattern is all about">
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>
@ -555,16 +559,21 @@ Description In depth description on what this Pattern is all about">
<a href=https://alguidelines.dev/docs/contributing/templates/>Templates</a>
</li>
<li class="breadcrumb-item active" aria-current=page>
<a href=https://alguidelines.dev/docs/contributing/templates/patterns/>Title of the pattern</a>
<a href=https://alguidelines.dev/docs/contributing/templates/patterns/>Pattern Name</a>
</li>
</ol>
</nav>
<div class=td-content>
<h1>Title of the pattern</h1>
<h1>Pattern Name</h1>
<header class=article-meta>
<div class="taxonomy taxonomy-terms-article taxo-categories">
<h5 class=taxonomy-title>Categories:</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span></a></li>
</ul>
</div>
</header>
<p>This is a guideline, some parts are optional (if there&rsquo;s no content, remove the whole paragraph).</p>
<p>&lt;<em>Created by (company), Described by (company)</em>></p>
<p><em>Created by Described by </em></p>
<h2 id=abstract>Abstract</h2>
<p>Short, descriptive and easy to remember description of this pattern.</p>
<h2 id=context>Context</h2>
@ -588,9 +597,10 @@ Description In depth description on what this Pattern is all about">
<h2 id=list-of-references>List of references</h2>
<p>Youtube-link? BaseApp? Tweet? &mldr;</p>
<h2 id=discussions>Discussions</h2>
<p>Create a discussions-page of your pattern, and add the sentence &ldquo;You can discuss this pattern <a href=https://github.com/microsoft/alguidelines/discussions/42>here</a>&rdquo; with the right link to that discussions-page.</p>
<p>Please discuss this guideline </p>
<p>You can find discussions on all &ldquo;Best Practices&rdquo; <a href=https://github.com/microsoft/alguidelines/discussions/categories/bc-patterns>here</a>.</p>
<div class="text-muted mt-5 pt-3 border-top">
Last modified February 20, 2022: <a href=https://github.com/microsoft/alguidelines/commit/3d0cb3a40bf1b3ca00d2c10d7a977e2a806818e3>Moving contributing (3d0cb3a4)</a>
Last modified February 21, 2022: <a href=https://github.com/microsoft/alguidelines/commit/22bceb14842a63d98699b2f26e7cb481bb38ce22>Update Templates for Docsy and synced them up (22bceb14)</a>
</div>
</div>
</main>

20
docs/contributing/theapprovalprocess/index.html
View file

@ -59,7 +59,7 @@
</li>
</ul>
</div>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div>
</nav>
</header>
@ -70,7 +70,7 @@
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.6d13347581f2cdfa89e23f0c68949bc2.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.16155e6a127efbc5f5c6e1a4492dd4fd.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form>
@ -467,17 +467,17 @@
<a href=/docs/contributing/formattingtips/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingformattingtips><span>Formatting tips</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-docscontributingforkandpr-li>
<a href=/docs/contributing/forkandpr/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingforkandpr><span>Guide to Fork & PR</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span class=td-sidebar-nav-active-item>Understanding the Approval Process</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-docscontributingtemplates-li>
<a href=/docs/contributing/templates/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-docscontributingtemplates><span>Templates</span></a>
<ul class="ul-3 foldable">
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesguidelines-li>
<a href=/docs/contributing/templates/guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesguidelines><span>Title of the Guideline</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Title of the pattern</span></a>
<li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatespatterns-li>
<a href=/docs/contributing/templates/patterns/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatespatterns><span>Pattern Name</span></a>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child collapse" id=m-docscontributingtemplatesbestpractice-li>
<a href=/docs/contributing/templates/bestpractice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-docscontributingtemplatesbestpractice><span>Title Here</span></a>
</li>
</ul>
</li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child active-path" id=m-docscontributingtheapprovalprocess-li>
<a href=/docs/contributing/theapprovalprocess/ class="align-left pl-0 active td-sidebar-link td-sidebar-link__page" id=m-docscontributingtheapprovalprocess><span class=td-sidebar-nav-active-item>Understanding the Approval Process</span></a>
</li>
</ul>
</li>
@ -509,8 +509,8 @@
<h5 class=taxonomy-title>Categories</h5>
<ul class=taxonomy-terms>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/archived-pattern/ data-taxonomy-term=archived-pattern><span class=taxonomy-label>Archived Pattern</span><span class=taxonomy-count>1</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>20</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>3</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/best-practice/ data-taxonomy-term=best-practice><span class=taxonomy-label>Best Practice</span><span class=taxonomy-count>21</span></a></li>
<li><a class=taxonomy-term href=https://alguidelines.dev/categories/pattern/ data-taxonomy-term=pattern><span class=taxonomy-label>Pattern</span><span class=taxonomy-count>4</span></a></li>
</ul>
</div>
</aside>