Automated-Docs-Fix-Additional-Description

Author: antoineaws

src/lib/docs-gen/package.json

@@ -16,7 +16,7 @@
     "gen-i18n-from-json-schema-fr": "pnpx ts-node scripts/generate-translation-file.ts fr ./output-schema/schema-fr.json ./output-translations/translation-fr.json",
     "gen-typedoc-all": "pnpm run gen-typedoc-en && pnpm run gen-typedoc-fr",
     "gen-typedoc-en": "rm -r ./output-docs/en; lang=en typedoc ./output-ts/en --name 'AWS SEA Config Docs' --hideGenerator --excludePrivate --localize en --templateStrings ./output-translations/translation-en.json --theme ./src/typedoc-theme --out ./output-docs/en --readme ./src/README-en.md",
-    "gen-typedoc-fr": "rm -r ./output-docs/fr; lang=fr typedoc ./output-ts/fr --name 'Documents Config AWS SEA' --hideGenerator --excludePrivate --localize fr --templateStrings ./output-translations/translation-fr.json --theme ./src/typedoc-theme --out ./output-docs/fr --readme ./src/README-fr.md",
+    "gen-typedoc-fr": "rm -r ./output-docs/fr; lang=fr typedoc ./output-ts/en --name 'Documents Config AWS SEA' --hideGenerator --excludePrivate --localize fr --templateStrings ./output-translations/translation-fr.json --theme ./src/typedoc-theme --out ./output-docs/fr --readme ./src/README-fr.md",
     "gen-docs": "pnpm run gen-json-schema-all && pnpm run gen-ts-from-json-schema-all && pnpm run gen-i18n-from-json-schema-all && pnpm run gen-typedoc-all",
     "build": "pnpm run gen-docs"
   },

src/lib/docs-gen/src/README-en.md

@@ -14,7 +14,7 @@ You can find detailed description on each field of the configuration file by acc
 - [Accelerator Configuration](./interfaces/AcceleratorConfiguration.html)
     - [Global Options](./interfaces/GlobalOptions.html)
     - [Mandatory Account Configs](./interfaces/SharedAccountConfig.html)
-    - [Organizational Units](./interfaces/OrganizationalUnit.html)
+    - [Organizational Units](./interfaces/OrganizationalUnitConfiguration.html)
     - [Workload Account Configs](./interfaces/SharedAccountConfig.html)
 
-- [All Config file "Interfaces"](./Modules.html)
+- [All Config file "Interfaces"](./modules.html)

src/lib/docs-gen/src/README-fr.md

@@ -14,9 +14,9 @@ You can find detailed description on each field of the configuration file by acc
 - [Accelerator Configuration](./interfaces/AcceleratorConfiguration.html)
     - [Global Options](./interfaces/GlobalOptions.html)
     - [Mandatory Account Configs](./interfaces/SharedAccountConfig.html)
-    - [Organizational Units](./interfaces/OrganizationalUnit.html)
+    - [Organizational Units](./interfaces/OrganizationalUnitConfiguration.html)
     - [Workload Account Configs](./interfaces/SharedAccountConfig.html)
 
-- [All Config file "Interfaces"](./Modules.html)
+- [All Config file "Interfaces"](./modules.html)
 
 

src/lib/docs-gen/src/helpers/translation-extract-helper.ts

@@ -28,6 +28,14 @@ export class TranslationExtractHelper {
         if (obj.additionalProperties) {
             this.iterate(obj.additionalProperties, obj.additionalProperties.title);
         }
+        if (obj.items) {
+            this.iterate(obj.items, obj.items.title);
+        }
+        if (obj.oneOf) {
+            for (const oneOfObj of obj.oneOf) {
+                this.iterate(oneOfObj, oneOfObj.title);
+            }
+        }
 
     }
     private generateTitle(title: string, propertyName: string) {

src/lib/docs-gen/src/i18n/base-en.json

@@ -5,7 +5,8 @@
         "app-title": "Accelerator config file documentation",
         "Hierarchy": "Hierarchy",
         "Inherited": "Inherited",
-        "Title":"Title",
-        "Description":"Description"
+        "Title": "Title",
+        "Description": "Description",
+        "Disclaimer": "The configuration file schema documentation is a work in progress. Please use this <b>draft</b> document with caution."
     }
 }

src/lib/docs-gen/src/i18n/base-fr.json

@@ -6,6 +6,7 @@
         "Hierarchy": "Hiérarchie",
         "Inherited": "Hérité",
         "Title": "Titre",
-        "Description": "Description"
+        "Description": "Description",
+        "Disclaimer": "(FR) The configuration file schema documentation is a work in progress. Please use this <b>draft</b> document with caution."
     }
 }

src/lib/docs-gen/src/typedoc-theme/assets/js/src/main-custom.js

@@ -2,7 +2,8 @@
     <div class="tsd-page-toolbar">
         <div class="container">
             <div class="table-wrap">
-                <div class="table-cell" id="tsd-search" data-index="{{relativeURL "assets/js/search.json"}}" data-base="{{relativeURL "./"}}">
+                <div class="table-cell" id="tsd-search" data-index="{{relativeURL " assets/js/search.json"}}"
+                    data-base="{{relativeURL " ./"}}">
                     <div class="field">
                         <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
                         <input id="tsd-search-field" type="text" />
@@ -18,8 +19,8 @@
                         {{/each}}
                     </ul>
 
-                    {{!-- <a href="{{relativeURL "index.html"}}" class="title">{{project.name}}</a> --}}
-                    <a href="{{relativeURL "index.html"}}" class="title">{{#localize}}app-title{{/localize}}</a>
+                    {{!-- <a href="{{relativeURL " index.html"}}" class="title">{{project.name}}</a> --}}
+                    <a href="{{relativeURL " index.html"}}" class="title">{{#localize}}app-title{{/localize}}</a>
                     {{#each settings.links}}
                     &emsp;<a href="{{url}}" class="title">{{label}}</a>
                     {{/each}}
@@ -38,7 +39,8 @@
                                 </ul>
                             </div>
                             <div class="tsd-select" id="tsd-language-filter">
-                                <span id="selected-language" class="tsd-select-label" data-language="{{#localize}}language-code{{/localize}}">{{#localize}}Language{{/localize}}</span>
+                                <span id="selected-language" class="tsd-select-label"
+                                    data-language="{{#localize}}language-code{{/localize}}">{{#localize}}Language{{/localize}}</span>
                                 <ul class="tsd-select-list" id="tsd-language-select-list">
                                     <li data-value="en">English</li>
                                     <li data-value="fr">Français</li>
@@ -49,13 +51,13 @@
                             <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
 
                             {{#unless settings.excludeExternals}}
-                                <input type="checkbox" id="tsd-filter-externals" checked />
-                                <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
+                            <input type="checkbox" id="tsd-filter-externals" checked />
+                            <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
                             {{/unless}}
 
                             {{#unless settings.excludeNotExported}}
-                                <input type="checkbox" id="tsd-filter-only-exported" />
-                                <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
+                            <input type="checkbox" id="tsd-filter-only-exported" />
+                            <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
                             {{/unless}}
                         </div>
                     </div>
@@ -65,12 +67,100 @@
             </div>
         </div>
     </div>
-    <div class="tsd-page-title">
+    <div class="tsd-page-title custom-breadcrumb">
         <div class="container">
             <ul class="tsd-breadcrumb">
                 {{#with model}}{{> breadcrumb}}{{/with}}
             </ul>
         </div>
     </div>
+    <div class="tsd-page-title disclaimer-wrapper">
+        <div class="container disclaimer">
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+                <title>Warning</title>
+                <path
+                    d="M85.57 446.25h340.86a32 32 0 0028.17-47.17L284.18 82.58c-12.09-22.44-44.27-22.44-56.36 0L57.4 399.08a32 32 0 0028.17 47.17z"
+                    fill="none" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="32" />
+                <path d="M250.26 195.39l5.74 122 5.73-121.95a5.74 5.74 0 00-5.79-6h0a5.74 5.74 0 00-5.68 5.95z"
+                    fill="none" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="32" />
+                <path fill="black" d="M256 397.25a20 20 0 1120-20 20 20 0 01-20 20z" />
+            </svg>
+            <h5>
+                {{#localize}}Disclaimer{{/localize}}
+            </h5>
+        </div>
+    </div>
 </header>
-<script src="{{relativeURL "assets/js/src/main-custom.js"}}"></script>
+<style>
+    .disclaimer-wrapper {
+        background: #FFD740;
+        padding: 0;
+    }
+
+    .custom-breadcrumb {
+        margin-bottom: 0px;
+    }
+
+    .disclaimer {
+        display: flex;
+        justify-content: flex-start;
+        align-items: center;
+    }
+
+    .disclaimer svg {
+        width: 40px;
+        margin-right: 15px;
+    }
+
+    .disclaimer h5 {
+        line-height: 20px;
+    }
+</style>
+<script>
+    function replaceMainBreadcrumbLink() {
+        const mainBreadcrumb = document.querySelector('.main-breadcrumb');
+        if (!mainBreadcrumb.href.indexOf("modules.html")) return;
+        mainBreadcrumb.href = mainBreadcrumb.href.replace(`/modules.html`, `/index.html`);
+    }
+    const currentLanguage = document.getElementById('selected-language').dataset.language;
+
+    const languageFilter = document.getElementById('tsd-language-filter');
+    languageFilter.addEventListener("mouseenter", (event) => {
+        languageFilter.classList.add("active");
+        const languageList = document.getElementById('tsd-language-select-list');
+        const items = languageList.getElementsByTagName('li');
+        for (const item of items) {
+            if (item.dataset.value === currentLanguage) {
+                item.classList.add('selected');
+                break;
+            }
+        }
+    });
+    languageFilter.addEventListener("mouseleave", (event) => {
+        languageFilter.classList.remove("active");
+    });
+
+    function addEventListenerToLanguages() {
+        const languageList = document.getElementById('tsd-language-select-list');
+        const items = languageList.getElementsByTagName('li');
+        for (const item of items) {
+            item.addEventListener("click", (event) => {
+                languageSelected(event, item);
+            });
+        }
+    }
+
+    function languageSelected(event, itemClicked) {
+        const selectedLanguage = itemClicked.dataset.value; //'en', 'fr', 'es', '..'
+        if (currentLanguage === selectedLanguage) return;
+        document.location = document.location.href.replace(`/${currentLanguage}/`, `/${selectedLanguage}/`);
+    }
+
+    function initializePage() {
+        addEventListenerToLanguages();
+        replaceMainBreadcrumbLink();
+    }
+    window.addEventListener('load', (event) => {
+        initializePage();
+    });
+</script>