generate docs

kptdev · Jun 24, 2020 · 6e69c12 · 6e69c12
1 parent f705c30
commit 6e69c12
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 18 deletions.
diff --git a/docs/guides/consumer/index.xml b/docs/guides/consumer/index.xml
@@ -380,7 +380,7 @@ line comments &amp;ndash; e.g. &lt;code&gt;# { &amp;quot;$kpt-set&amp;quot;: &am
 &lt;h2 id=&#34;fetch-a-remote-package&#34;&gt;Fetch a remote package&lt;/h2&gt;
 &lt;h3 id=&#34;command&#34;&gt;Command&lt;/h3&gt;
 &lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;&lt;span style=&#34;color:#204a87&#34;&gt;export&lt;/span&gt; &lt;span style=&#34;color:#000&#34;&gt;SRC_REPO&lt;/span&gt;&lt;span style=&#34;color:#ce5c00;font-weight:bold&#34;&gt;=&lt;/span&gt;https://github.com/GoogleContainerTools/kpt.git
-kpt pkg get &lt;span style=&#34;color:#000&#34;&gt;$SRC_REPO&lt;/span&gt;/package-examples/helloworld-set@v0.3.0 helloworld
+kpt pkg get &lt;span style=&#34;color:#000&#34;&gt;$SRC_REPO&lt;/span&gt;/package-examples/helloworld-set@v0.6.0 helloworld
 &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;h3 id=&#34;output&#34;&gt;Output&lt;/h3&gt;
 &lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;fetching package /package-examples/helloworld-set from https://github.com/GoogleContainerTools/kpt to helloworld
 &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;h2 id=&#34;list-the-setters&#34;&gt;List the setters&lt;/h2&gt;
@@ -390,10 +390,12 @@ kpt pkg get &lt;span style=&#34;color:#000&#34;&gt;$SRC_REPO&lt;/span&gt;/packag
 &lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;kpt cfg list-setters helloworld/ 
 &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Print the list of setters included in the package.&lt;/p&gt;
 &lt;h5 id=&#34;output-1&#34;&gt;Output&lt;/h5&gt;
-&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;    NAME      VALUE       SET BY             DESCRIPTION        COUNT  
-  http-port   &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;80&lt;/span&gt;      package-default   helloworld port         &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;3&lt;/span&gt;      
-  image-tag   0.1.0   package-default   hello-world image tag   &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;1&lt;/span&gt;      
-  replicas    &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;5&lt;/span&gt;       package-default   helloworld replicas     &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;1&lt;/span&gt;     
+&lt;div class=&#34;highlight&#34;&gt;&lt;pre style=&#34;background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;    NAME      VALUE        SET BY            DESCRIPTION        COUNT
+  http-port   &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;80&lt;/span&gt;       package-default   helloworld port        &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;3&lt;/span&gt;
+  image-tag   v0.1.0   package-default   helloworld image tag   &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;1&lt;/span&gt;
+  replicas    &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;5&lt;/span&gt;        package-default   helloworld replicas    &lt;span style=&#34;color:#0000cf;font-weight:bold&#34;&gt;1&lt;/span&gt;
+  SUBSTITUTION                    PATTERN                     REFERENCES
+  image          gcr.io/kpt-dev/helloworld-gke:&lt;span style=&#34;color:#4e9a06&#34;&gt;${&lt;/span&gt;&lt;span style=&#34;color:#000&#34;&gt;image&lt;/span&gt;&lt;span style=&#34;color:#000;font-weight:bold&#34;&gt;-tag&lt;/span&gt;&lt;span style=&#34;color:#4e9a06&#34;&gt;}&lt;/span&gt;   &lt;span style=&#34;color:#ce5c00;font-weight:bold&#34;&gt;[&lt;/span&gt;image-tag&lt;span style=&#34;color:#ce5c00;font-weight:bold&#34;&gt;]&lt;/span&gt;
 &lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;The package contains 3 setters which may be used to modify the configuration
 using &lt;code&gt;kpt set&lt;/code&gt;.&lt;/p&gt;
 &lt;h2 id=&#34;set-a-field&#34;&gt;Set a field&lt;/h2&gt;

diff --git a/docs/guides/consumer/set/index.html b/docs/guides/consumer/set/index.html
@@ -911,7 +911,7 @@ <h2 id="steps">Steps</h2>
 <h2 id="fetch-a-remote-package">Fetch a remote package</h2>
 <h3 id="command">Command</h3>
 <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh"><span style="color:#204a87">export</span> <span style="color:#000">SRC_REPO</span><span style="color:#ce5c00;font-weight:bold">=</span>https://github.com/GoogleContainerTools/kpt.git
-kpt pkg get <span style="color:#000">$SRC_REPO</span>/package-examples/helloworld-set@v0.3.0 helloworld
+kpt pkg get <span style="color:#000">$SRC_REPO</span>/package-examples/helloworld-set@v0.6.0 helloworld
 </code></pre></div><h3 id="output">Output</h3>
 <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">fetching package /package-examples/helloworld-set from https://github.com/GoogleContainerTools/kpt to helloworld
 </code></pre></div><h2 id="list-the-setters">List the setters</h2>
@@ -921,10 +921,12 @@ <h5 id="command-1">Command</h5>
 <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">kpt cfg list-setters helloworld/ 
 </code></pre></div><p>Print the list of setters included in the package.</p>
 <h5 id="output-1">Output</h5>
-<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">    NAME      VALUE       SET BY             DESCRIPTION        COUNT  
-  http-port   <span style="color:#0000cf;font-weight:bold">80</span>      package-default   helloworld port         <span style="color:#0000cf;font-weight:bold">3</span>      
-  image-tag   0.1.0   package-default   hello-world image tag   <span style="color:#0000cf;font-weight:bold">1</span>      
-  replicas    <span style="color:#0000cf;font-weight:bold">5</span>       package-default   helloworld replicas     <span style="color:#0000cf;font-weight:bold">1</span>     
+<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">    NAME      VALUE        SET BY            DESCRIPTION        COUNT
+  http-port   <span style="color:#0000cf;font-weight:bold">80</span>       package-default   helloworld port        <span style="color:#0000cf;font-weight:bold">3</span>
+  image-tag   v0.1.0   package-default   helloworld image tag   <span style="color:#0000cf;font-weight:bold">1</span>
+  replicas    <span style="color:#0000cf;font-weight:bold">5</span>        package-default   helloworld replicas    <span style="color:#0000cf;font-weight:bold">1</span>
+  SUBSTITUTION                    PATTERN                     REFERENCES
+  image          gcr.io/kpt-dev/helloworld-gke:<span style="color:#4e9a06">${</span><span style="color:#000">image</span><span style="color:#000;font-weight:bold">-tag</span><span style="color:#4e9a06">}</span>   <span style="color:#ce5c00;font-weight:bold">[</span>image-tag<span style="color:#ce5c00;font-weight:bold">]</span>
 </code></pre></div><p>The package contains 3 setters which may be used to modify the configuration
 using <code>kpt set</code>.</p>
 <h2 id="set-a-field">Set a field</h2>
@@ -1016,7 +1018,7 @@ <h5 id="output-2">Output</h5>
 
 
 
-	<div class="text-muted mt-5 pt-3 border-top">Last modified June 15, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/488fac19b256ce64424bc7b8e6e39efac0997d47">Update setters docs (488fac19)</a>
+	<div class="text-muted mt-5 pt-3 border-top">Last modified June 23, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/f705c3071e6b2ecfd3040cc44ca580578c707e15">docs: Fix missing substitution in example output in set guide (f705c307)</a>
 </div>
 </div>
 

diff --git a/docs/guides/consumer/substitute/index.html b/docs/guides/consumer/substitute/index.html
@@ -1037,7 +1037,7 @@ <h5 id="output-2">Output</h5>
 
 
 
-	<div class="text-muted mt-5 pt-3 border-top">Last modified June 15, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/488fac19b256ce64424bc7b8e6e39efac0997d47">Update setters docs (488fac19)</a>
+	<div class="text-muted mt-5 pt-3 border-top">Last modified June 18, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/d7cc5dcaba3542b6e462899d446b7c584621cf8f">Update docs (d7cc5dca)</a>
 </div>
 </div>
 

diff --git a/docs/guides/producer/setters/index.html b/docs/guides/producer/setters/index.html
@@ -1140,7 +1140,7 @@ <h4 id="setting-lists">Setting Lists</h4>
 
 
 
-	<div class="text-muted mt-5 pt-3 border-top">Last modified June 15, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/488fac19b256ce64424bc7b8e6e39efac0997d47">Update setters docs (488fac19)</a>
+	<div class="text-muted mt-5 pt-3 border-top">Last modified June 18, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/d7cc5dcaba3542b6e462899d446b7c584621cf8f">Update docs (d7cc5dca)</a>
 </div>
 </div>
 

diff --git a/docs/reference/pkg/get/index.html b/docs/reference/pkg/get/index.html
@@ -1054,7 +1054,7 @@ <h3 id="synopsis">Synopsis</h3>
 
 
 
-	<div class="text-muted mt-5 pt-3 border-top">Last modified March 22, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/4397847ac7f8c642d62df6ef5123189ff5bb89e2">Fix indentation in generated Long message (4397847a)</a>
+	<div class="text-muted mt-5 pt-3 border-top">Last modified June 18, 2020: <a  href="https://github.com/GoogleContainerTools/kpt/commit/d7cc5dcaba3542b6e462899d446b7c584621cf8f">Update docs (d7cc5dca)</a>
 </div>
 </div>
 

diff --git a/docs/sitemap.xml b/docs/sitemap.xml
@@ -84,7 +84,7 @@
 
   <url>
     <loc>https://googlecontainertools.github.io/kpt/guides/producer/setters/</loc>
-    <lastmod>2020-06-15T20:34:10-07:00</lastmod>
+    <lastmod>2020-06-18T21:48:53-07:00</lastmod>
   </url>
 
   <url>
@@ -114,7 +114,7 @@
 
   <url>
     <loc>https://googlecontainertools.github.io/kpt/guides/consumer/set/</loc>
-    <lastmod>2020-06-15T20:34:10-07:00</lastmod>
+    <lastmod>2020-06-23T21:53:30-07:00</lastmod>
   </url>
 
   <url>
@@ -194,7 +194,7 @@
 
   <url>
     <loc>https://googlecontainertools.github.io/kpt/guides/consumer/substitute/</loc>
-    <lastmod>2020-06-15T20:34:10-07:00</lastmod>
+    <lastmod>2020-06-18T21:48:53-07:00</lastmod>
   </url>
 
   <url>
@@ -309,7 +309,7 @@
 
   <url>
     <loc>https://googlecontainertools.github.io/kpt/reference/pkg/get/</loc>
-    <lastmod>2020-03-22T23:09:14-07:00</lastmod>
+    <lastmod>2020-06-18T21:48:53-07:00</lastmod>
   </url>
 
   <url>