Merge pull request #53 from aurora-is-near/chore-update-md-template-f…

…ormat chore: update md template format
aurora-is-near · Apr 18, 2024 · 3a48421 · 3a48421
2 parents 451317b + 949b9d4
commit 3a48421
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 107 deletions.
diff --git a/templates/backstage/access-keys.md.hbs b/templates/backstage/access-keys.md.hbs
@@ -1,43 +1,41 @@
 # Contracts with Access Keys
+{{#each accessKeySystemComponents}}
 
-{{#each accessKeySystemComponents~}}
+## [{{title}}]({{backstageLink system}})
+{{#if system.metadata.description}}
 
-    ## [{{title}}]({{backstageLink system}})
+{{system.metadata.description}}
+{{/if}}
+{{#each components}}
 
-    {{#if system.metadata.description~}}
-        {{system.metadata.description}}
-    {{/if}}
+### [{{title}}]({{backstageLink component}}){{#each tags}} `{{this}}`{{/each}}
+{{#if component.metadata.description}}
 
-    {{#each components~}}
-        ### [{{title}}]({{backstageLink component}}){{#each tags}} `{{this}}`{{/each}}
+{{component.metadata.description}}
+{{/if}}
+{{#each contracts}}
 
-        {{#if component.metadata.description~}}
-            {{component.metadata.description}}
-        {{/if}}
+#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
+{{#if entity.metadata.description}}
 
-        {{#each contracts~}}
-            #### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
+{{entity.metadata.description}}
+{{/if}}
+{{#if keys}}
 
-            {{#if entity.metadata.description~}}
-                {{entity.metadata.description}}
-            {{/if}}
+##### Keys
 
-            {{#if keys~}}
-                ##### Keys
-
-                {{#each keys~}}
-                    - [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{key.metadata.name}}]({{backstageLink key}})) (`{{tags}}`)
-                {{/each}}
-            {{/if}}
-
-            {{#if entity.metadata.links~}}
-                ##### External Links
-                {{#each entity.metadata.links~}}
-                    - [{{title}}]({{url}})
-                {{/each}}
-            {{/if}}
+{{#each keys}}
+- [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{key.metadata.name}}]({{backstageLink key}})){{#each tags}} `{{this}}`{{/each}}
+{{/each}}
+{{/if}}
+{{#if entity.metadata.links}}
 
-        {{/each}}
-    {{/each}}
+##### External Links
 
+{{#each entity.metadata.links}}
+- [{{title}}]({{url}})
+{{/each}}
+{{/if}}
+{{/each}}
+{{/each}}
 {{/each}}
diff --git a/templates/backstage/eoa.md.hbs b/templates/backstage/eoa.md.hbs
@@ -1,47 +1,41 @@
 # Addresses
+{{#each addresses}}
 
-{{#each addresses~}}
-### [{{signer.metadata.title}}]({{backstageLink signer}})
-
+## [{{signer.metadata.title}}]({{backstageLink signer}})
 {{#if signer.metadata.description}}
-{{signer.metadata.description}}
 
+{{signer.metadata.description}}
 {{/if}}
-
 {{#if contracts}}
-#### Contracts
+
+### Contracts
 
 {{#each contracts}}
 - [{{this.metadata.title}}]({{backstageLink this}})
 {{/each}}
-
 {{/if}}
-
 {{#if keys}}
-#### Keys
+
+### Keys
 
 {{#each keys}}
 - [{{this.metadata.title}}]({{backstageLink this}})
 {{/each}}
-
 {{/if}}
-
 {{#if roles}}
-#### Roles
+
+### Roles
 
 {{#each roles}}
 - [{{this.metadata.title}}]({{backstageLink this}})
 {{/each}}
-
 {{/if}}
-
 {{#if signer.metadata.links}}
-###### External Links
+
+### External Links
 
 {{#each signer.metadata.links}}
 - [{{title}}]({{url}})
 {{/each}}
-
 {{/if}}
-
 {{/each}}
diff --git a/templates/backstage/multisigs.md.hbs b/templates/backstage/multisigs.md.hbs
@@ -1,55 +1,49 @@
 # Multisigs
+{{#each multisigSystemComponents}}
 
-{{#each multisigSystemComponents~}}
+## [{{title}}]({{backstageLink system}})
+{{#if system.metadata.description}}
 
-    ## [{{title}}]({{backstageLink system}})
+{{system.metadata.description}}
+{{/if}}
+{{#each components}}
 
-    {{#if system.metadata.description~}}
-        {{system.metadata.description}}
-    {{/if}}
+### [{{component.metadata.title}}]({{backstageLink component}}){{#each tags}} `{{this}}`{{/each}}
+{{#if component.metadata.description}}
 
-    {{#each components~}}
-        ### [{{component.metadata.title}}]({{backstageLink component}}){{#each tags}} `{{this}}`{{/each}}
+{{component.metadata.description}}
+{{/if}}
+{{#each multisigs}}
 
-        {{#if component.metadata.description~}}
-            {{component.metadata.description}}
-        {{/if}}
+#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
+{{#if entity.metadata.description}}
 
-        {{#each multisigs~}}
-            #### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
+{{entity.metadata.description}}
+{{/if}}
+{{#with entity.spec.multisig}}
+{{#if policy}}
 
-            {{#if entity.metadata.description~}}
-                {{entity.metadata.description}}
-            {{/if}}
+Policy Threshold: {{policy.threshold}}/{{policy.owners}}
 
-            {{#with entity.spec.multisig~}}
-                {{#if policy~}}
-                    ##### Policy Threshold: {{policy.threshold}}/{{policy.owners}}
-                {{/if}}
-            {{/with}}
+Version: {{version}}
+{{/if}}
+{{/with}}
+{{#if signers}}
 
-            {{#with entity.spec.multisig~}}
-                {{#if policy~}}
-                    ##### Version: {{version}}
-                {{/if}}
-            {{/with}}
+##### Signers
 
-            {{#if signers~}}
-                ##### Signers
-
-                {{#each signers~}}
-                    - [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{signer.metadata.name}}]({{backstageLink signer}})){{#each tags}} `{{this}}`{{/each}}
-                {{/each}}
-            {{/if}}
-
-            {{#if entity.metadata.links~}}
-                ##### External Links
-                {{#each entity.metadata.links~}}
-                    - [{{title}}]({{url}})
-                {{/each}}
-            {{/if}}
+{{#each signers}}
+- [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{signer.metadata.name}}]({{backstageLink signer}})){{#each tags}} `{{this}}`{{/each}}
+{{/each}}
+{{/if}}
+{{#if entity.metadata.links }}
 
-        {{/each}}
-    {{/each}}
+##### External Links
 
+{{#each entity.metadata.links}}
+- [{{title}}]({{url}})
+{{/each}}
+{{/if}}
+{{/each}}
+{{/each}}
 {{/each}}
diff --git a/templates/backstage/unknown.md.hbs b/templates/backstage/unknown.md.hbs
@@ -1,84 +1,81 @@
 # Unknown Entities
-
 {{#each unknownSystemComponents}}
 
 ## [{{title}}]({{backstageLink system}})
-
 {{#if system.metadata.description}}
+
 {{system.metadata.description}}
 {{/if}}
+{{#each components}}
 
-{{#each components~}}
 ### [{{title}}]({{backstageLink component}}){{#each tags}} `{{this}}`{{/each}}
-
 {{#if component.metadata.description}}
-{{component.metadata.description}}
 
+{{component.metadata.description}}
 {{/if}}
-
 {{#if contracts}}
 {{#each contracts}}
-#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
 
+#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
 {{#if entity.metadata.description}}
-{{entity.metadata.description}}
 
+{{entity.metadata.description}}
 {{/if}}
-
 {{#if keys}}
+
 ##### Access Keys
 
 {{#each keys}}
 - [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{key.metadata.name}}]({{backstageLink key}})){{#each tags}} `{{this}}`{{/each}}
 {{/each}}
 {{/if}}
-
 {{#if roles}}
+
 ##### Role Groups
 
 {{#each roles}}
 {{#if role.metadata.title}}
-##### [{{role.metadata.title}}]({{backstageLink role}})
 
+##### [{{role.metadata.title}}]({{backstageLink role}})
 {{/if}}
 {{#if members}}
+
 ##### Members
 
 {{#each members}}
 - [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{member.metadata.title}}]({{backstageLink member}}))
 {{/each}}
-
 {{/if}}
 {{/each}}
 {{/if}}
-
 {{#if entity.metadata.links}}
+
 ##### External Links
 
 {{#each entity.metadata.links}}
 - [{{title}}]({{url}})
 {{/each}}
 {{/if}}
-
 {{/each}}
 {{/if}}
-
 {{#if multisigs}}
 {{#each multisigs}}
-#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
 
+#### [{{entity.metadata.title}}]({{backstageLink entity}}){{#each tags}} `{{this}}`{{/each}}
 {{#if entity.metadata.description}}
-{{entity.metadata.description}}
 
+{{entity.metadata.description}}
 {{/if}}
 {{#if signers}}
+
 ##### Signers
 
 {{#each signers}}
 - [{{owner.metadata.name}}]({{backstageLink owner}}) ([{{signer.metadata.name}}]({{backstageLink signer}})){{#each tags}} `{{this}}`{{/each}}
 {{/each}}
 {{/if}}
 {{#if entity.metadata.links}}
+
 ##### External Links
 
 {{#each entity.metadata.links}}
@@ -87,6 +84,5 @@
 {{/if}}
 {{/each}}
 {{/if}}
-
 {{/each}}
 {{/each}}