Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4f5f162 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonas-wielage-sonarsource
jonas-wielage-sonarsource committed Mar 21, 2024
1 parent ca2bb9e commit f2fcb7e
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 25 deletions.
60 changes: 48 additions & 12 deletions rules/S6956/azureresourcemanager-description.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ <h2 id="_how_to_fix_it_in_bicep">How to fix it in Bicep</h2>
</div>
</div>
<div class="paragraph">
<p>Any other properties or elements not listed here should be placed before the <code>properties</code> object for the resource.</p>
<p>Any other decorated not listed here should be placed before the <code>resource</code> object and after the other decorators.
Any other properties or elements not listed here should be placed before the <code>properties</code> object for the resource.</p>
</div>
</div>
</div>
Expand All @@ -136,10 +137,10 @@ <h3 id="_documentation">Documentation</h3>
<p>Azure quickstart templates best practices - <a href="https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/best-practices.md#sort-order-of-properties">Sort order of properties</a></p>
</li>
<li>
<p>Microsoft Azure - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Understand the structure and syntax of ARM templates - Template Format</a></p>
<p>Microsoft Azure - Understand the structure and syntax of ARM templates - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Template Format</a></p>
</li>
<li>
<p>Microsoft Azure - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Understand the structure and syntax of Bicep files - Bicep Format</a></p>
<p>Microsoft Azure - Understand the structure and syntax of Bicep files - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Bicep Format</a></p>
</li>
</ul>
</div>
Expand All @@ -156,24 +157,59 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
<div class="sect2">
<h3 id="_message">Message</h3>
<div class="paragraph">
<p>In case of wrong order of top-level elements:
* Reorder the properties and elements to match the recommended order.</p>
<p>In case of wrong order of top-level elements:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Primary Issue Message: Reorder the properties and elements to match the recommended order.
This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
<li>
<p>Secondary Issue Message: This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>In case of wrong order in a resource:
* Reorder the properties and elements inside the resource to match the recommended order.</p>
<p>In case of wrong order in a resource:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Primary Issue Message: Reorder the properties and elements inside the resource to match the recommended order.
This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
<li>
<p>Secondary Issue Message: This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_highlighting">Highlighting</h3>
<div class="paragraph">
<p>In case of wrong order of top-level elements:
* Highlight the first top-level element?
* Highlight the second top-level element that is not in the correct order?</p>
<p>In general, we want to highlight all the keys of elements that are in the wrong order.</p>
</div>
<div class="paragraph">
<p>In case of wrong order in a resource:
* Highlight the name of the resource with a wrong order of elements inside</p>
<p>For wrong order in top-level elements:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The first wrongly ordered element should be highlighted as primary issue and the others as secondary locations.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>For wrong order in a resource:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The name of the resource / key of the resource should be highlighted as a primary issues.
All the wrongly ordered elements should be highlighted as secondary locations.</p>
</li>
</ul>
</div>
<hr>
</div>
Expand Down
60 changes: 48 additions & 12 deletions rules/S6956/default-description.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ <h2 id="_how_to_fix_it_in_bicep">How to fix it in Bicep</h2>
</div>
</div>
<div class="paragraph">
<p>Any other properties or elements not listed here should be placed before the <code>properties</code> object for the resource.</p>
<p>Any other decorated not listed here should be placed before the <code>resource</code> object and after the other decorators.
Any other properties or elements not listed here should be placed before the <code>properties</code> object for the resource.</p>
</div>
</div>
</div>
Expand All @@ -136,10 +137,10 @@ <h3 id="_documentation">Documentation</h3>
<p>Azure quickstart templates best practices - <a href="https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/best-practices.md#sort-order-of-properties">Sort order of properties</a></p>
</li>
<li>
<p>Microsoft Azure - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Understand the structure and syntax of ARM templates - Template Format</a></p>
<p>Microsoft Azure - Understand the structure and syntax of ARM templates - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Template Format</a></p>
</li>
<li>
<p>Microsoft Azure - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Understand the structure and syntax of Bicep files - Bicep Format</a></p>
<p>Microsoft Azure - Understand the structure and syntax of Bicep files - <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/syntax#template-format">Bicep Format</a></p>
</li>
</ul>
</div>
Expand All @@ -156,24 +157,59 @@ <h2 id="_implementation_specification">Implementation Specification</h2>
<div class="sect2">
<h3 id="_message">Message</h3>
<div class="paragraph">
<p>In case of wrong order of top-level elements:
* Reorder the properties and elements to match the recommended order.</p>
<p>In case of wrong order of top-level elements:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Primary Issue Message: Reorder the properties and elements to match the recommended order.
This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
<li>
<p>Secondary Issue Message: This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>In case of wrong order in a resource:
* Reorder the properties and elements inside the resource to match the recommended order.</p>
<p>In case of wrong order in a resource:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Primary Issue Message: Reorder the properties and elements inside the resource to match the recommended order.
This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
<li>
<p>Secondary Issue Message: This <code>&lt;nameOfTheWronglyOrderedKey&gt;</code> object should be located after the <code>&lt;nameOfTheKeyThatShouldComeBeforeIt&gt;</code> object.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="_highlighting">Highlighting</h3>
<div class="paragraph">
<p>In case of wrong order of top-level elements:
* Highlight the first top-level element?
* Highlight the second top-level element that is not in the correct order?</p>
<p>In general, we want to highlight all the keys of elements that are in the wrong order.</p>
</div>
<div class="paragraph">
<p>In case of wrong order in a resource:
* Highlight the name of the resource with a wrong order of elements inside</p>
<p>For wrong order in top-level elements:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The first wrongly ordered element should be highlighted as primary issue and the others as secondary locations.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>For wrong order in a resource:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>The name of the resource / key of the resource should be highlighted as a primary issues.
All the wrongly ordered elements should be highlighted as secondary locations.</p>
</li>
</ul>
</div>
<hr>
</div>
Expand Down
2 changes: 1 addition & 1 deletion rules/rule-index.json
View file

Large diffs are not rendered by default.

0 comments on commit f2fcb7e

Please sign in to comment.