Skip to content

Conversation

zirain
Copy link
Member

@zirain zirain commented Oct 13, 2022

fix most of markdown render issue

with this PR, istio/api still need updated as following chagnes:

diff --git a/analysis/v1alpha1/message.pb.html b/analysis/v1alpha1/message.pb.html
index 5d9640a7..6d768504 100644
--- a/analysis/v1alpha1/message.pb.html
+++ b/analysis/v1alpha1/message.pb.html
@@ -173,7 +173,7 @@ No
 <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
diff --git a/extensions/v1alpha1/wasm.pb.html b/extensions/v1alpha1/wasm.pb.html
index ed75cdb2..d90bfe06 100644
--- a/extensions/v1alpha1/wasm.pb.html
+++ b/extensions/v1alpha1/wasm.pb.html
@@ -10,18 +10,14 @@ number_of_entries: 6
 ---
 <p>WasmPlugins provides a mechanism to extend the functionality provided by
 the Istio proxy through WebAssembly filters.</p>
-
 <p>Order of execution (as part of Envoy&rsquo;s filter chain) is determined by
 phase and priority settings, allowing the configuration of complex
 interactions between user-supplied WasmPlugins and Istio&rsquo;s internal
 filters.</p>
-
 <p>Examples:</p>
-
 <p>AuthN Filter deployed to ingress-gateway that implements an OpenID flow
 and populates the <code>Authorization</code> header with a JWT to be consumed by
 Istio AuthN.</p>
-
 <pre><code class="language-yaml">apiVersion: extensions.istio.io/v1alpha1
 kind: WasmPlugin
:...skipping...
diff --git a/analysis/v1alpha1/message.pb.html b/analysis/v1alpha1/message.pb.html
index 5d9640a7..6d768504 100644
--- a/analysis/v1alpha1/message.pb.html
+++ b/analysis/v1alpha1/message.pb.html
@@ -173,7 +173,7 @@ No
 <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
diff --git a/extensions/v1alpha1/wasm.pb.html b/extensions/v1alpha1/wasm.pb.html
index ed75cdb2..d90bfe06 100644
--- a/extensions/v1alpha1/wasm.pb.html
+++ b/extensions/v1alpha1/wasm.pb.html
@@ -10,18 +10,14 @@ number_of_entries: 6
 ---
 <p>WasmPlugins provides a mechanism to extend the functionality provided by
 the Istio proxy through WebAssembly filters.</p>
-
 <p>Order of execution (as part of Envoy&rsquo;s filter chain) is determined by
 phase and priority settings, allowing the configuration of complex
 interactions between user-supplied WasmPlugins and Istio&rsquo;s internal
 filters.</p>
-
 <p>Examples:</p>
-
 <p>AuthN Filter deployed to ingress-gateway that implements an OpenID flow
 and populates the <code>Authorization</code> header with a JWT to be consumed by
 Istio AuthN.</p>
-
 <pre><code class="language-yaml">apiVersion: extensions.istio.io/v1alpha1
 kind: WasmPlugin
 metadata:
@@ -38,9 +34,7 @@ spec:
     openid_server: authn
     openid_realm: ingress
 </code></pre>
-
 <p>This is the same as the last example, but using an OCI image.</p>
-
 <pre><code class="language-yaml">apiVersion: extensions.istio.io/v1alpha1
 kind: WasmPlugin
 metadata:
@@ -58,9 +52,7 @@ spec:
     openid_server: authn
     openid_realm: ingress
 </code></pre>
-
 <p>This is the same as the last example, but using VmConfig to configure environment variables in the VM.</p>
-
 <pre><code class="language-yaml">apiVersion: extensions.istio.io/v1alpha1
 kind: WasmPlugin
 metadata:
@@ -84,9 +76,7 @@ spec:
     - name: TRUST_DOMAIN
       value: &quot;cluster.local&quot;
 </code></pre>
-
 <p>This is also the same as the last example, but the Wasm module is pulled via https and updated for each time when this plugin resource is changed.</p>
-
 <pre><code class="language-yaml">apiVersion: extensions.istio.io/v1alpha1
 kind: WasmPlugin
 metadata:
@@ -109,7 +99,6 @@ spec:
     - name: TRUST_DOMAIN
       value: &quot;cluster.local&quot;
 </code></pre>

@ericvn WDYT?

@zirain zirain requested a review from a team as a code owner October 13, 2022 02:54
@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 13, 2022
@ericvn
Copy link
Contributor

ericvn commented Oct 13, 2022

See istio/istio.io#12086 for what happens if the GFM extension is used. I think that looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants