Skip to content

DNM Test with reference docs using Goldmark in istio/api #12086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ericvn wants to merge 3 commits into from
Closed

DNM Test with reference docs using Goldmark in istio/api #12086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b121a6
Test with reference docs using Goldmark in istio/api
Oct 12, 2022
105c841
Update to use GFM and Unsafe.
Oct 13, 2022
bda4007
Use the latest build tools image
Oct 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en/docs/reference/config/annotations/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ericvn/api' REPO
source_repo: https://github.com/ericvn/api
title: Resource Annotations
description: Resource annotations used by Istio.
location: https://istio.io/docs/reference/config/annotations/
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/reference/config/istio.analysis.v1alpha1/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ericvn/api' REPO
source_repo: https://github.com/ericvn/api
title: Analysis Messages
description: Describes the structure of messages generated by Istio analyzers.
location: https://istio.io/docs/reference/config/istio.analysis.v1alpha1.html
layout: protoc-gen-docs
layout: partner-component
generator: protoc-gen-docs
weight: 20
number_of_entries: 7
Expand Down Expand Up @@ -106,7 +106,7 @@ <h2 id="AnalysisMessageWeakSchema">AnalysisMessageWeakSchema</h2>
<td><code>template</code></td>
<td><code>string</code></td>
<td>
<p>A go-style template string (https://golang.org/pkg/fmt/#hdr-Printing)
<p>A go-style template string (<a href="https://golang.org/pkg/fmt/#hdr-Printing">https://golang.org/pkg/fmt/#hdr-Printing</a>)
defining how to combine the args for a particular message into a log line.
Required.</p>

Expand Down Expand Up @@ -175,10 +175,10 @@ <h2 id="GenericAnalysisMessage">GenericAnalysisMessage</h2>
<td><code>string[]</code></td>
<td>
<p>A list of strings specifying the resource identifiers that were the cause
of message generation. A &ldquo;path&rdquo; here is a (NAMESPACE\/)?RESOURCETYPE/NAME
of message generation. A &ldquo;path&rdquo; here is a (NAMESPACE/)?RESOURCETYPE/NAME
tuple that uniquely identifies a particular resource. There doesn&rsquo;t seem to
be a single concept for this, but this is intuitively taken from
https://kubernetes.io/docs/reference/using-api/api-concepts/#standard-api-terminology
<a href="https://kubernetes.io/docs/reference/using-api/api-concepts/#standard-api-terminology">https://kubernetes.io/docs/reference/using-api/api-concepts/#standard-api-terminology</a>
At least one is required.</p>

</td>
Expand Down
198 changes: 80 additions & 118 deletions content/en/docs/reference/config/istio.mesh.v1alpha1/index.html
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 6 additions & 12 deletions content/en/docs/reference/config/istio.operator.v1alpha1/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ericvn/api' REPO
source_repo: https://github.com/ericvn/api
title: IstioOperator Options
description: Configuration affecting Istio control plane installation version and shape.
location: https://istio.io/docs/reference/config/istio.operator.v1alpha1.html
layout: protoc-gen-docs
layout: partner-component
generator: protoc-gen-docs
weight: 20
number_of_entries: 74
Expand All @@ -21,7 +21,6 @@ <h2 id="IstioOperatorSpec">IstioOperatorSpec</h2>
The spec is a used to define a customization of the default profile values that are supplied with each Istio release.
Because the spec is a customization API, specifying an empty IstioOperatorSpec results in a default Istio
component values.</p>

<pre><code class="language-yaml">apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
Expand Down Expand Up @@ -53,12 +52,10 @@ <h2 id="IstioOperatorSpec">IstioOperatorSpec</h2>
<td><code>string</code></td>
<td>
<p>Path or name for the profile e.g.</p>

<ul>
<li>minimal (looks in profiles dir for a file called minimal.yaml)</li>
<li>/tmp/istio/install/values/custom/custom-install.yaml (local file path)</li>
</ul>

<p>default profile is used if this field is unset.</p>

</td>
Expand All @@ -71,7 +68,6 @@ <h2 id="IstioOperatorSpec">IstioOperatorSpec</h2>
<td><code>string</code></td>
<td>
<p>Path for the install package. e.g.</p>

<ul>
<li>/tmp/istio-installer/nightly (local file path)</li>
</ul>
Expand Down Expand Up @@ -224,7 +220,6 @@ <h2 id="InstallStatus">InstallStatus</h2>
<td><code><a href="#InstallStatus-Status">Status</a></code></td>
<td>
<p>Overall status of all components controlled by the operator.</p>

<ul>
<li>If all components have status <code>NONE</code>, overall status is <code>NONE</code>.</li>
<li>If all components are <code>HEALTHY</code>, overall status is <code>HEALTHY</code>.</li>
Expand Down Expand Up @@ -3770,7 +3765,6 @@ <h2 id="google-protobuf-Value">google.protobuf.Value</h2>
null, a number, a string, a boolean, a recursive struct value, or a
list of values. A producer of value is expected to set one of that
variants, absence of any variant indicates an error.</p>

<p>The JSON representation for <code>Value</code> is JSON value.</p>

<table class="message-fields">
Expand Down Expand Up @@ -3872,7 +3866,7 @@ <h2 id="k8s-io-api-core-v1-Volume">k8s.io.api.core.v1.Volume</h2>
<td>
<p>name of the volume.
Must be a DNS_LABEL and unique within the pod.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</p>
More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</a></p>

</td>
<td>
Expand Down Expand Up @@ -3950,7 +3944,7 @@ <h2 id="k8s-io-api-core-v1-VolumeMount">k8s.io.api.core.v1.VolumeMount</h2>
<td><code>string</code></td>
<td>
<p>Path within the volume from which the container&rsquo;s volume should be mounted.
Defaults to &ldquo;&rdquo; (volume&rsquo;s root).
Defaults to &quot;&quot; (volume&rsquo;s root).
+optional</p>

</td>
Expand Down Expand Up @@ -3979,7 +3973,7 @@ <h2 id="k8s-io-api-core-v1-VolumeMount">k8s.io.api.core.v1.VolumeMount</h2>
<td>
<p>Expanded path within the volume from which the container&rsquo;s volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container&rsquo;s environment.
Defaults to &ldquo;&rdquo; (volume&rsquo;s root).
Defaults to &quot;&quot; (volume&rsquo;s root).
SubPathExpr and SubPath are mutually exclusive.
+optional</p>

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/reference/config/labels/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ericvn/api' REPO
source_repo: https://github.com/ericvn/api
title: Resource Labels
description: Resource labels used by Istio.
location: https://istio.io/docs/reference/config/labels/
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/reference/config/meta/v1beta1/istio-status/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
source_repo: https://github.com/istio/api
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ericvn/api' REPO
source_repo: https://github.com/ericvn/api
title: Istio Status
description: Common status field for all istio collections.
location: https://istio.io/docs/reference/config/meta/v1beta1/istio-status.html
layout: protoc-gen-docs
layout: partner-component
generator: protoc-gen-docs
number_of_entries: 2
---
Expand All @@ -25,7 +25,7 @@ <h2 id="IstioStatus">IstioStatus</h2>
<td><code><a href="#IstioCondition">IstioCondition[]</a></code></td>
<td>
<p>Current service state of pod.
More info: https://istio.io/docs/reference/config/config-status/
More info: <a href="/docs/reference/config/config-status/">https://istio.io/docs/reference/config/config-status/</a>
+optional
+patchMergeKey=type
+patchStrategy=merge</p>
Expand Down Expand Up @@ -55,7 +55,7 @@ <h2 id="IstioStatus">IstioStatus</h2>
<td>
<p>Resource Generation to which the Reconciled Condition refers.
When this value is not equal to the object&rsquo;s metadata generation, reconciled condition calculation for the current
generation is still in progress. See https://istio.io/latest/docs/reference/config/config-status/ for more info.
generation is still in progress. See <a href="/docs/reference/config/config-status/">https://istio.io/latest/docs/reference/config/config-status/</a> for more info.
+optional</p>

</td>
Expand Down
Loading