Skip to content

Commit fb2fe89

Browse files
committed
Deployed e7acc18 with MkDocs version: 1.6.1
1 parent 78adeae commit fb2fe89

File tree

7 files changed

+154
-28
lines changed

7 files changed

+154
-28
lines changed

dev-guide/creating-a-report-module/index.html

Lines changed: 128 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2004,6 +2004,21 @@
20042004
</span>
20052005
</a>
20062006

2007+
<nav class="md-nav" aria-label="Language Configuration">
2008+
<ul class="md-nav__list">
2009+
2010+
<li class="md-nav__item">
2011+
<a href="#languages-supported-by-asbuiltreportcore" class="md-nav__link">
2012+
<span class="md-ellipsis">
2013+
Languages supported by AsBuiltReport.Core
2014+
</span>
2015+
</a>
2016+
2017+
</li>
2018+
2019+
</ul>
2020+
</nav>
2021+
20072022
</li>
20082023

20092024
<li class="md-nav__item">
@@ -3309,6 +3324,21 @@
33093324
</span>
33103325
</a>
33113326

3327+
<nav class="md-nav" aria-label="Language Configuration">
3328+
<ul class="md-nav__list">
3329+
3330+
<li class="md-nav__item">
3331+
<a href="#languages-supported-by-asbuiltreportcore" class="md-nav__link">
3332+
<span class="md-ellipsis">
3333+
Languages supported by AsBuiltReport.Core
3334+
</span>
3335+
</a>
3336+
3337+
</li>
3338+
3339+
</ul>
3340+
</nav>
3341+
33123342
</li>
33133343

33143344
<li class="md-nav__item">
@@ -4106,7 +4136,103 @@ <h3 id="language-configuration">Language Configuration</h3>
41064136
<li><strong>Recommended:</strong> Report modules should aim to support as many languages as possible from the available languages list</li>
41074137
<li><strong>Optional:</strong> Additional languages can be provided based on contributor availability and community needs</li>
41084138
</ul>
4109-
<p><strong>Available languages supported by AsBuiltReport.Core:</strong> en-US (default), en-GB, es-ES, fr-FR, de-DE, it-IT, pt-PT, ja-JP, zh-CN, zh-Hans, zh-Hant, ar-SA, ru-RU, ko-KR, nl-NL, sv-SE, nb-NO, da-DK, fi-FI, pl-PL, cs-CZ, hu-HU, tr-TR, el-GR, he-IL, hi-IN, th-TH, vi-VN</p>
4139+
<h4 id="languages-supported-by-asbuiltreportcore">Languages supported by AsBuiltReport.Core</h4>
4140+
<table>
4141+
<thead>
4142+
<tr>
4143+
<th>Locale Code</th>
4144+
<th>Language</th>
4145+
<th>Locale Code</th>
4146+
<th>Language</th>
4147+
</tr>
4148+
</thead>
4149+
<tbody>
4150+
<tr>
4151+
<td><strong>en-US (default)</strong></td>
4152+
<td>English (United States)</td>
4153+
<td><strong>hu-HU</strong></td>
4154+
<td>Hungarian (Hungary)</td>
4155+
</tr>
4156+
<tr>
4157+
<td><strong>en-GB</strong></td>
4158+
<td>English (United Kingdom)</td>
4159+
<td><strong>it-IT</strong></td>
4160+
<td>Italian (Italy)</td>
4161+
</tr>
4162+
<tr>
4163+
<td><strong>ar-SA</strong></td>
4164+
<td>Arabic (Saudi Arabia)</td>
4165+
<td><strong>ja-JP</strong></td>
4166+
<td>Japanese (Japan)</td>
4167+
</tr>
4168+
<tr>
4169+
<td><strong>cs-CZ</strong></td>
4170+
<td>Czech (Czech Republic)</td>
4171+
<td><strong>ko-KR</strong></td>
4172+
<td>Korean (South Korea)</td>
4173+
</tr>
4174+
<tr>
4175+
<td><strong>da-DK</strong></td>
4176+
<td>Danish (Denmark)</td>
4177+
<td><strong>nb-NO</strong></td>
4178+
<td>Norwegian Bokmål (Norway)</td>
4179+
</tr>
4180+
<tr>
4181+
<td><strong>de-DE</strong></td>
4182+
<td>German (Germany)</td>
4183+
<td><strong>nl-NL</strong></td>
4184+
<td>Dutch (Netherlands)</td>
4185+
</tr>
4186+
<tr>
4187+
<td><strong>el-GR</strong></td>
4188+
<td>Greek (Greece)</td>
4189+
<td><strong>pl-PL</strong></td>
4190+
<td>Polish (Poland)</td>
4191+
</tr>
4192+
<tr>
4193+
<td><strong>es-ES</strong></td>
4194+
<td>Spanish (Spain)</td>
4195+
<td><strong>pt-PT</strong></td>
4196+
<td>Portuguese (Portugal)</td>
4197+
</tr>
4198+
<tr>
4199+
<td><strong>fi-FI</strong></td>
4200+
<td>Finnish (Finland)</td>
4201+
<td><strong>ru-RU</strong></td>
4202+
<td>Russian (Russia)</td>
4203+
</tr>
4204+
<tr>
4205+
<td><strong>fr-FR</strong></td>
4206+
<td>French (France)</td>
4207+
<td><strong>sv-SE</strong></td>
4208+
<td>Swedish (Sweden)</td>
4209+
</tr>
4210+
<tr>
4211+
<td><strong>he-IL</strong></td>
4212+
<td>Hebrew (Israel)</td>
4213+
<td><strong>th-TH</strong></td>
4214+
<td>Thai (Thailand)</td>
4215+
</tr>
4216+
<tr>
4217+
<td><strong>hi-IN</strong></td>
4218+
<td>Hindi (India)</td>
4219+
<td><strong>tr-TR</strong></td>
4220+
<td>Turkish (Turkey)</td>
4221+
</tr>
4222+
<tr>
4223+
<td><strong>vi-VN</strong></td>
4224+
<td>Vietnamese (Vietnam)</td>
4225+
<td><strong>zh-CN</strong></td>
4226+
<td>Chinese (China, Simplified)</td>
4227+
</tr>
4228+
<tr>
4229+
<td><strong>zh-Hans</strong></td>
4230+
<td>Chinese (Simplified)</td>
4231+
<td><strong>zh-Hant</strong></td>
4232+
<td>Chinese (Traditional)</td>
4233+
</tr>
4234+
</tbody>
4235+
</table>
41104236
<p>For comprehensive language mapping and fallback chains, see the <a href="#language-support-implementation">Language Support Implementation</a> section below.</p>
41114237
<h3 id="infolevel-standards">InfoLevel Standards</h3>
41124238
<p>Implement consistent information levels across all sections. Use the appropriate number of InfoLevel values based on the granular detail levels your report module requires:</p>
@@ -5319,7 +5445,7 @@ <h3 id="getting-help">Getting Help</h3>
53195445
<span class="md-icon" title="Last update">
53205446
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
53215447
</span>
5322-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 9, 2025 23:13:41 UTC">October 9, 2025</span>
5448+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="October 13, 2025 06:35:45 UTC">October 13, 2025</span>
53235449
</span>
53245450

53255451

feed_json_updated.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"version": "https://jsonfeed.org/version/1", "title": "AsBuiltReport", "home_page_url": "https://www.asbuiltreport.com/", "feed_url": "https://www.asbuiltreport.com/feed_json_updated.json", "description": "Document Your Datacenter With PowerShell", "icon": null, "authors": [{"name": "Tim Carman"}], "language": "en", "items": [{"id": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "url": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "title": "The history of AsBuiltReport", "content_html": "<h1>The history of AsBuiltReport</h1>\n<h2>The Beginning</h2>\n<p>Back in 2017, having worked on designing and implementing VMware solutions for almost a decade, I became frustrated with having to repeatedly produce as-built documentation for my virtualisation projects.</p>\n<p>At the time, I was designing and implementing 2-3 VMware solutions per month. Each solution would be designed using numerous technology partners, each with their own range of compute, storage, networking and backup technologies.</p>\n<p>My methods to create as-built documentation was arduous, time consuming and error prone. It often involved extracting information using a combination of vendor supplied tools and community developed scripts, and manually transposing information from the vCenter console into a Word document. It was tedious and often resulted in a poorly constructed and formatted document.</p>\n<p>It was also around this time that I realised I had a strong desire to learn PowerShell after seeing many of my co-workers starting to write scripts to automate simple, repeatable tasks. Until this moment, I had never taken the time to completely understand the fundamentals of PowerShell, nor had I worked to develop and expand my knowledge in any form of scripting or automation.</p>\n<p>As a result, I saw this as an opportunity to learn and employ PowerShell automation to ease my pain and frustrations with producing as-built documentation. And so began my mission to create AsBuiltReport!</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\The-history-of-As-Built-Report.png", "date_modified": "2025-10-12T01:58:12.919654+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "url": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "title": "The future of AsBuiltReport", "content_html": "<h1>The future of AsBuiltReport</h1>\n<p>In my <a href=\"../posts/The-history-of-As-Built-Report.md\">previous post</a> I shared how I came to start AsBuiltReport and my reasons for doing so. It's been a few years since its inception and some of you may be asking what does the future hold for the project?</p>\n<p>Before I delve into what may lie ahead, let me take a moment to reflect on the project's progression so far, by extending a sincere thank you to all the <a href=\"../../about/contributors.md\">contributors</a> who have given their time and effort to this project. Whether you have contributed code, reported bugs, provided feedback, written a blog post, or simply participated in discussions, your efforts have not gone unnoticed.</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\The-future-of-As-Built-Report.png", "date_modified": "2025-10-12T01:58:11.221258+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "url": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "title": "Multilingual support is coming soon to AsBuiltReport", "content_html": "<h1>Multilingual support is coming soon to AsBuiltReport</h1>\n<p>Today I can announce that one of the most requested features for AsBuiltReport is currently in pre-release, with testing underway to bring <strong>multilingual support</strong> to the AsBuiltReport framework.</p>\n<p><img alt=\"multilingual\" src=\"../../assets/images/blog/multilingual.jpg\">{ loading=lazy }</p>\n<h2>Key Features in Development</h2>\n<p><strong>\ud83c\udf10 Comprehensive Localization Framework</strong></p>\n<ul>\n<li>\n<p>Implementation of PowerShell's built-in localization capabilities</p>\n</li>\n<li>\n<p>Option for differing UI localization and report localization</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcdd Standardised Translation Structure</strong></p>\n<ul>\n<li>\n<p>Standardised folder structures for simple multilingual support adoption</p>\n</li>\n<li>\n<p>Support for resource files containing translated strings for AsBuiltReport core and report modules</p>\n</li>\n<li>\n<p>Automated string extraction and translation</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcbb New Commandline Parameters</strong></p>\n<ul>\n<li>\n<p>Dynamic language selection - language selection is determined by what each AsBuiltReport module supports</p>\n</li>\n<li>\n<p>Support for standard locale codes (en-US, es-ES, fr-FR, de-DE, etc.)</p>\n</li>\n<li>\n<p>Fallback mechanism to ensure reports generate even with incomplete translations</p>\n</li>\n</ul>\n<p><strong>:gear: Report Module Integration</strong></p>\n<ul>\n<li>\n<p>Documentation and templates for new and existing report modules to add multilingual support</p>\n</li>\n<li>\n<p>Backward compatibility ensuring existing English-only workflows continue to work</p>\n</li>\n<li>\n<p>Progressive enhancement allowing modules to adopt localization incrementally</p>\n</li>\n</ul>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\Multilingual-support-coming-soon.png", "date_modified": "2025-10-12T01:58:09.360023+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["Announcements", "Features"]}]}
1+
{"version": "https://jsonfeed.org/version/1", "title": "AsBuiltReport", "home_page_url": "https://www.asbuiltreport.com/", "feed_url": "https://www.asbuiltreport.com/feed_json_updated.json", "description": "Document Your Datacenter With PowerShell", "icon": null, "authors": [{"name": "Tim Carman"}], "language": "en", "items": [{"id": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "url": "https://www.asbuiltreport.com/blog/2023/08/25/the-history-of-asbuiltreport/", "title": "The history of AsBuiltReport", "content_html": "<h1>The history of AsBuiltReport</h1>\n<h2>The Beginning</h2>\n<p>Back in 2017, having worked on designing and implementing VMware solutions for almost a decade, I became frustrated with having to repeatedly produce as-built documentation for my virtualisation projects.</p>\n<p>At the time, I was designing and implementing 2-3 VMware solutions per month. Each solution would be designed using numerous technology partners, each with their own range of compute, storage, networking and backup technologies.</p>\n<p>My methods to create as-built documentation was arduous, time consuming and error prone. It often involved extracting information using a combination of vendor supplied tools and community developed scripts, and manually transposing information from the vCenter console into a Word document. It was tedious and often resulted in a poorly constructed and formatted document.</p>\n<p>It was also around this time that I realised I had a strong desire to learn PowerShell after seeing many of my co-workers starting to write scripts to automate simple, repeatable tasks. Until this moment, I had never taken the time to completely understand the fundamentals of PowerShell, nor had I worked to develop and expand my knowledge in any form of scripting or automation.</p>\n<p>As a result, I saw this as an opportunity to learn and employ PowerShell automation to ease my pain and frustrations with producing as-built documentation. And so began my mission to create AsBuiltReport!</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\The-history-of-As-Built-Report.png", "date_modified": "2025-10-13T06:38:30.732507+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "url": "https://www.asbuiltreport.com/blog/2023/12/05/The-future-of-As-Built-Report/", "title": "The future of AsBuiltReport", "content_html": "<h1>The future of AsBuiltReport</h1>\n<p>In my <a href=\"../posts/The-history-of-As-Built-Report.md\">previous post</a> I shared how I came to start AsBuiltReport and my reasons for doing so. It's been a few years since its inception and some of you may be asking what does the future hold for the project?</p>\n<p>Before I delve into what may lie ahead, let me take a moment to reflect on the project's progression so far, by extending a sincere thank you to all the <a href=\"../../about/contributors.md\">contributors</a> who have given their time and effort to this project. Whether you have contributed code, reported bugs, provided feedback, written a blog post, or simply participated in discussions, your efforts have not gone unnoticed.</p>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\The-future-of-As-Built-Report.png", "date_modified": "2025-10-13T06:38:28.625293+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["General"]}, {"id": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "url": "https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/", "title": "Multilingual support is coming soon to AsBuiltReport", "content_html": "<h1>Multilingual support is coming soon to AsBuiltReport</h1>\n<p>Today I can announce that one of the most requested features for AsBuiltReport is currently in pre-release, with testing underway to bring <strong>multilingual support</strong> to the AsBuiltReport framework.</p>\n<p><img alt=\"multilingual\" src=\"../../assets/images/blog/multilingual.jpg\">{ loading=lazy }</p>\n<h2>Key Features in Development</h2>\n<p><strong>\ud83c\udf10 Comprehensive Localization Framework</strong></p>\n<ul>\n<li>\n<p>Implementation of PowerShell's built-in localization capabilities</p>\n</li>\n<li>\n<p>Option for differing UI localization and report localization</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcdd Standardised Translation Structure</strong></p>\n<ul>\n<li>\n<p>Standardised folder structures for simple multilingual support adoption</p>\n</li>\n<li>\n<p>Support for resource files containing translated strings for AsBuiltReport core and report modules</p>\n</li>\n<li>\n<p>Automated string extraction and translation</p>\n</li>\n</ul>\n<p><strong>\ud83d\udcbb New Commandline Parameters</strong></p>\n<ul>\n<li>\n<p>Dynamic language selection - language selection is determined by what each AsBuiltReport module supports</p>\n</li>\n<li>\n<p>Support for standard locale codes (en-US, es-ES, fr-FR, de-DE, etc.)</p>\n</li>\n<li>\n<p>Fallback mechanism to ensure reports generate even with incomplete translations</p>\n</li>\n</ul>\n<p><strong>:gear: Report Module Integration</strong></p>\n<ul>\n<li>\n<p>Documentation and templates for new and existing report modules to add multilingual support</p>\n</li>\n<li>\n<p>Backward compatibility ensuring existing English-only workflows continue to work</p>\n</li>\n<li>\n<p>Progressive enhancement allowing modules to adopt localization incrementally</p>\n</li>\n</ul>", "image": "https://www.asbuiltreport.com/assets/images/social/blog\\posts\\Multilingual-support-coming-soon.png", "date_modified": "2025-10-13T06:38:26.148935+00:00", "authors": [{"name": "Tim Carman"}], "tags": ["Announcements", "Features"]}]}

0 commit comments

Comments
 (0)