mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 8082501bb3 to master with MkDocs 1.2.3 and mike 1.1.2
This commit is contained in:
1 parent
7f29274615
commit
1f4284ab15
15 files changed
+482
-298
No files matched your search
@@ -777,6 +777,7 @@
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="group">group<a class="headerlink" href="#group" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>group</strong>: <code>string</code></p>
|
||||
<p>The grouping for for the category. This MUST be a DNS label.</p>
|
||||
<hr />
|
||||
<h3 id="names">names<a class="headerlink" href="#names" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>names</strong>: <code>Object</code></p>
|
||||
@@ -786,18 +787,24 @@
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>kind</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The kind of entity that this category is for. This value MUST be a DNS label and MUST be equal to the <code>kind</code> fields that are produced by the <code>.versions.[] | .entityClass</code> fields.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr />
|
||||
<h3 id="versions">versions<a class="headerlink" href="#versions" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>versions</strong>: <a href="../Common.Catalog.CatalogCategoryVersion/"><code>CatalogCategoryVersion</code></a><<a href="../../classes/Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a><<a href="../Common.Catalog.CatalogEntityMetadata/"><code>CatalogEntityMetadata</code></a>, <a href="../Common.Catalog.CatalogEntityStatus/"><code>CatalogEntityStatus</code></a>, <a href="../../modules/Common.Catalog/#catalogentityspec"><code>CatalogEntitySpec</code></a>>>[]</p>
|
||||
<p>The specific versions of the constructors.</p>
|
||||
<p>NOTE: the field <code>.apiVersion</code> after construction MUST match <code>{.group}/{.versions.[] | .name}</code>.
|
||||
For example, if <code>group = "entity.k8slens.dev"</code> and there is an entry in <code>.versions</code> with
|
||||
<code>name = "v1alpha1"</code> then the resulting <code>.apiVersion</code> MUST be <code>entity.k8slens.dev/v1alpha1</code></p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -791,9 +791,18 @@
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="entityclass">entityClass<a class="headerlink" href="#entityclass" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>entityClass</strong>: <a href="../../modules/Common.Catalog/#catalogentityconstructor"><code>CatalogEntityConstructor</code></a><<code>Entity</code>></p>
|
||||
<p>The constructor for the entities.</p>
|
||||
<hr />
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>name</strong>: <code>string</code></p>
|
||||
<p>The specific version that the associated constructor is for. This MUST be
|
||||
a DNS label and SHOULD be of the form <code>vN</code>, <code>vNalphaY</code>, or <code>vNbetaY</code> where
|
||||
<code>N</code> and <code>Y</code> are both integers greater than 0.</p>
|
||||
<p>Examples: The following are valid values for this field.
|
||||
- <code>v1</code>
|
||||
- <code>v1beta1</code>
|
||||
- <code>v1alpha2</code>
|
||||
- <code>v3beta2</code></p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -758,6 +758,13 @@
|
||||
name
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#shortname" class="md-nav__link">
|
||||
shortName
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -808,6 +815,7 @@
|
||||
<li><a href="./#description">description</a></li>
|
||||
<li><a href="./#labels">labels</a></li>
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#shortname">shortName</a></li>
|
||||
<li><a href="./#source">source</a></li>
|
||||
<li><a href="./#uid">uid</a></li>
|
||||
</ul>
|
||||
@@ -821,6 +829,9 @@
|
||||
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>name</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="shortname">shortName<a class="headerlink" href="#shortname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>shortName</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
<h3 id="source">source<a class="headerlink" href="#source" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>source</strong>: <code>string</code></p>
|
||||
<hr />
|
||||
|
||||
+15
-2
@@ -765,6 +765,13 @@
|
||||
name
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#shortname" class="md-nav__link">
|
||||
shortName
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -815,6 +822,7 @@
|
||||
<li><a href="./#kubeversion">kubeVersion</a></li>
|
||||
<li><a href="./#labels">labels</a></li>
|
||||
<li><a href="./#name">name</a></li>
|
||||
<li><a href="./#shortname">shortName</a></li>
|
||||
<li><a href="./#source">source</a></li>
|
||||
<li><a href="./#uid">uid</a></li>
|
||||
</ul>
|
||||
@@ -840,14 +848,19 @@
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Common.Catalog.CatalogEntityMetadata/">CatalogEntityMetadata</a>.<a href="../Common.Catalog.CatalogEntityMetadata/#name">name</a></p>
|
||||
<hr />
|
||||
<h3 id="shortname">shortName<a class="headerlink" href="#shortname" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>shortName</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Common.Catalog.CatalogEntityMetadata/">CatalogEntityMetadata</a>.<a href="../Common.Catalog.CatalogEntityMetadata/#shortname">shortName</a></p>
|
||||
<hr />
|
||||
<h3 id="source">source<a class="headerlink" href="#source" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Optional</code> <strong>source</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Common.Catalog.CatalogEntityMetadata/">CatalogEntityMetadata</a>.<a href="../Common.Catalog.CatalogEntityMetadata/#source">source</a></p>
|
||||
<hr />
|
||||
<h3 id="uid">uid<a class="headerlink" href="#uid" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>uid</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Common.Catalog.CatalogEntityMetadata/">CatalogEntityMetadata</a>.<a href="../Common.Catalog.CatalogEntityMetadata/#uid">uid</a></p>
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user