Deployed 452042f5c5 to master with MkDocs 1.5.2 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2023-08-09 13:45:00 +00:00
1 parent 02aaf1710c
commit 8f9ec26ed7
313 files changed
+14863 -14863

No files matched your search

@@ -17,7 +17,7 @@
<link rel="icon" href="../../../../img/favicon.ico">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
@@ -25,7 +25,7 @@
<link rel="stylesheet" href="../../../../assets/stylesheets/main.26e3688c.min.css">
<link rel="stylesheet" href="../../../../assets/stylesheets/main.eebd395e.min.css">
<link rel="stylesheet" href="../../../../assets/stylesheets/palette.ecc896b0.min.css">
@@ -1195,14 +1195,14 @@
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>extension</code></td>
<td align="left"><a href="../../modules/Common/#installedextension"><code>InstalledExtension</code></a></td>
<td style="text-align: left;"><code>extension</code></td>
<td style="text-align: left;"><a href="../../modules/Common/#installedextension"><code>InstalledExtension</code></a></td>
</tr>
</tbody>
</table>
@@ -1219,7 +1219,7 @@
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[]</p>
<hr />
<h3 id="catalogentitydetailitems">catalogEntityDetailItems<a class="headerlink" href="#catalogentitydetailitems" title="Permanent link">#</a></h3>
<p>• <strong>catalogEntityDetailItems</strong>: <code>CatalogEntityDetailRegistration</code>&lt;<a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a>&lt;<a href="../../interfaces/Common.Catalog.CatalogEntityMetadata/"><code>CatalogEntityMetadata</code></a>, <a href="../../interfaces/Common.Catalog.CatalogEntityStatus/"><code>CatalogEntityStatus</code></a>, <a href="../../modules/Common.Catalog/#catalogentityspec"><code>CatalogEntitySpec</code></a>>>[]</p>
<p>• <strong>catalogEntityDetailItems</strong>: <code>CatalogEntityDetailRegistration</code>&lt;<a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a>&lt;<a href="../../interfaces/Common.Catalog.CatalogEntityMetadata/"><code>CatalogEntityMetadata</code></a>, <a href="../../interfaces/Common.Catalog.CatalogEntityStatus/"><code>CatalogEntityStatus</code></a>, <a href="../../modules/Common.Catalog/#catalogentityspec"><code>CatalogEntitySpec</code></a>&gt;&gt;[]</p>
<hr />
<h3 id="clusterframecomponents">clusterFrameComponents<a class="headerlink" href="#clusterframecomponents" title="Permanent link">#</a></h3>
<p>• <strong>clusterFrameComponents</strong>: <code>ClusterFrameChildComponent</code>[]</p>
@@ -1253,7 +1253,7 @@
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#isbundled">isBundled</a></p>
<hr />
<h3 id="kubeobjectdetailitems">kubeObjectDetailItems<a class="headerlink" href="#kubeobjectdetailitems" title="Permanent link">#</a></h3>
<p>• <strong>kubeObjectDetailItems</strong>: <a href="../../interfaces/Common.Types.KubeObjectDetailRegistration/"><code>KubeObjectDetailRegistration</code></a>&lt;<a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a>&lt;<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a>&lt;<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>[]</p>
<p>• <strong>kubeObjectDetailItems</strong>: <a href="../../interfaces/Common.Types.KubeObjectDetailRegistration/"><code>KubeObjectDetailRegistration</code></a>&lt;<a href="../Main.K8sApi.KubeObject/"><code>KubeObject</code></a>&lt;<a href="../../modules/Main.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a>&lt;<code>KubeObjectScope</code>&gt;, <code>unknown</code>, <code>unknown</code>&gt;&gt;[]</p>
<hr />
<h3 id="kubeobjecthandlers">kubeObjectHandlers<a class="headerlink" href="#kubeobjecthandlers" title="Permanent link">#</a></h3>
<p>• <strong>kubeObjectHandlers</strong>: <a href="../../modules/Common.Types/#kubeobjecthandlerregistration"><code>KubeObjectHandlerRegistration</code></a>[]</p>
@@ -1337,9 +1337,9 @@
<p>LensExtension.version</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
<p>▸ <strong>activate</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <strong>activate</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#activate">activate</a></p>
<hr />
@@ -1350,16 +1350,16 @@
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>fn</code></td>
<td align="left"><code>CategoryFilter</code></td>
<td align="left">The function which should return a truthy value for those categories which should be kept.</td>
<td style="text-align: left;"><code>fn</code></td>
<td style="text-align: left;"><code>CategoryFilter</code></td>
<td style="text-align: left;">The function which should return a truthy value for those categories which should be kept.</td>
</tr>
</tbody>
</table>
@@ -1374,16 +1374,16 @@
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>fn</code></td>
<td align="left"><code>EntityFilter</code></td>
<td align="left">The function which should return a truthy value for those entities which should be kept.</td>
<td style="text-align: left;"><code>fn</code></td>
<td style="text-align: left;"><code>EntityFilter</code></td>
<td style="text-align: left;">The function which should return a truthy value for those entities which should be kept.</td>
</tr>
</tbody>
</table>
@@ -1392,32 +1392,32 @@
<p>A function to clean up the filter</p>
<hr />
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
<p>▸ <strong>disable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <strong>disable</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#disable">disable</a></p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <strong>enable</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#enable">enable</a></p>
<hr />
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code>&lt;<code>string</code>></p>
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code>&lt;<code>string</code>&gt;</p>
<p>getExtensionFileFolder returns the path to an already created folder. This
folder is for the sole use of this extension.</p>
<p>Note: there is no security done on this folder, only obfuscation of the
folder name.</p>
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<p><code>Promise</code>&lt;<code>string</code>&gt;</p>
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#getextensionfilefolder">getExtensionFileFolder</a></p>
<hr />
<h3 id="isenabledforcluster">isEnabledForCluster<a class="headerlink" href="#isenabledforcluster" title="Permanent link">#</a></h3>
<p>▸ <strong>isEnabledForCluster</strong>(<code>cluster</code>): <code>Promise</code>&lt;<code>Boolean</code>></p>
<p>▸ <strong>isEnabledForCluster</strong>(<code>cluster</code>): <code>Promise</code>&lt;<code>Boolean</code>&gt;</p>
<p>Defines if extension is enabled for a given cluster. This method is only
called when the extension is created within a cluster frame.</p>
<p>The default implementation is to return <code>true</code></p>
@@ -1427,55 +1427,55 @@ called when the extension is created within a cluster frame.</p>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>cluster</code></td>
<td align="left"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a>&lt;<a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>></td>
<td style="text-align: left;"><code>cluster</code></td>
<td style="text-align: left;"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a>&lt;<a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>&gt;</td>
</tr>
</tbody>
</table>
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>Boolean</code>></p>
<p><code>Promise</code>&lt;<code>Boolean</code>&gt;</p>
<hr />
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>): <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>pageId?</code></td>
<td align="left"><code>string</code></td>
<td style="text-align: left;"><code>pageId?</code></td>
<td style="text-align: left;"><code>string</code></td>
</tr>
<tr>
<td align="left"><code>params?</code></td>
<td align="left"><code>object</code></td>
<td style="text-align: left;"><code>params?</code></td>
<td style="text-align: left;"><code>object</code></td>
</tr>
</tbody>
</table>
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>void</code>></p>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p>
<hr />
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#onactivate">onActivate</a></p>
<hr />
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>></p>
<p><code>void</code> | <code>Promise</code>&lt;<code>void</code>&gt;</p>
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
<p><a href="../Common.LensExtension/">LensExtension</a>.<a href="../Common.LensExtension/#ondeactivate">onDeactivate</a></p>
@@ -1552,10 +1552,10 @@ called when the extension is created within a cluster frame.</p>
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../../../assets/javascripts/bundle.b4d07000.min.js"></script>
<script src="../../../../assets/javascripts/bundle.220ee61c.min.js"></script>
</body>