Automatic documentation update

oracle · Aug 29, 2024 · 36b914c · 36b914c
1 parent a1c7ab9
commit 36b914c
Show file tree

Hide file tree

Showing 28 changed files with 81 additions and 55 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 97d93972a72528f4c8dbf238472aa3d3
+config: 1b8114cd590526e695cc5bfa567b2207
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/changelog.md.txt b/_sources/changelog.md.txt
@@ -5,6 +5,8 @@
 Any changes which are committed, but not yet present in a released version,
 should appear here.
 
+## 1.7.0 - Thu, Aug 29, 2024
+
 - Yo now has support for multiple OCI regions!
   - Previously, if you wanted to run yo against another OCI region, you needed
     to edit your config, run `yo cache-clean`, and then run your commands.
@@ -16,6 +18,12 @@ should appear here.
     https://oracle.github.io/yo/guide/region.html#migrating-yo-ini-to-multi-region-support
 - Switched Yo's default setup dialog to use ``oci setup keys``. Updated
   documentation accordingly.
+- Yo can now use OCI API keys which have a passphrase. It will automatically
+  detect that a passphrase is required, and prompt only when attempting to use
+  the API. Since many API results are cached, prompts aren't terribly frequent.
+- The Yo image list now uses "natural sort". This ensures that images with
+  numbers like "8.10" sort after "8.9", which is important if you have an
+  operating system image with that version number :P
 
 
 ## 1.6.0 - Wed, Apr 17, 2024

diff --git a/_sources/install.rst.txt b/_sources/install.rst.txt
@@ -55,7 +55,9 @@ contains the code ``NotAuthorizedOrNotFound``, then there's an alternative way
 to setup your OCI credentials:
 
 1. Run ``oci setup keys``. At the prompt, you probably want to type "N/A" to
-   avoid setting a passphrase for the key.
+   avoid setting a passphrase for the key. However, if you really feel it is
+   necessary, you can use a passphrase. Yo will detect that it is necessary and
+   prompt you for it.
 2. Open the OCI web console. Navigate to your profile using the icon at the top
    right (or search your email address in the search bar). On your profile page,
    select the "API keys" link, and then choose "Add API key".

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'v1.6.0',
+    VERSION: 'v1.7.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/changelog.html b/changelog.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Changelog &#8212; yo v1.6.0 documentation</title>
+    <title>Changelog &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
-    <script src="_static/documentation_options.js?v=896c6380"></script>
+    <script src="_static/documentation_options.js?v=f8b929d9"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/yo.png"/>
@@ -37,6 +37,9 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading
 <h2>Unreleased<a class="headerlink" href="#unreleased" title="Link to this heading">¶</a></h2>
 <p>Any changes which are committed, but not yet present in a released version,
 should appear here.</p>
+</section>
+<section id="thu-aug-29-2024">
+<h2>1.7.0 - Thu, Aug 29, 2024<a class="headerlink" href="#thu-aug-29-2024" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Yo now has support for multiple OCI regions!</p>
 <ul>
@@ -52,6 +55,12 @@ <h2>Unreleased<a class="headerlink" href="#unreleased" title="Link to this headi
 </li>
 <li><p>Switched Yo’s default setup dialog to use <code class="docutils literal notranslate"><span class="pre">oci</span> <span class="pre">setup</span> <span class="pre">keys</span></code>. Updated
 documentation accordingly.</p></li>
+<li><p>Yo can now use OCI API keys which have a passphrase. It will automatically
+detect that a passphrase is required, and prompt only when attempting to use
+the API. Since many API results are cached, prompts aren’t terribly frequent.</p></li>
+<li><p>The Yo image list now uses “natural sort”. This ensures that images with
+numbers like “8.10” sort after “8.9”, which is important if you have an
+operating system image with that version number :P</p></li>
 </ul>
 </section>
 <section id="wed-apr-17-2024">

diff --git a/cmds/cmd00.html b/cmds/cmd00.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Basic Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Basic Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd01.html b/cmds/cmd01.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Instance Management &#8212; yo v1.6.0 documentation</title>
+    <title>Instance Management &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd02.html b/cmds/cmd02.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Instance Communication &amp; Interaction &#8212; yo v1.6.0 documentation</title>
+    <title>Instance Communication &amp; Interaction &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd03.html b/cmds/cmd03.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Task Management Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Task Management Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd04.html b/cmds/cmd04.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Volume Management Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Volume Management Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd05.html b/cmds/cmd05.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Informative Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Informative Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/cmd06.html b/cmds/cmd06.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Diagnostic Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Diagnostic Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/cmds/index.html b/cmds/index.html
@@ -5,17 +5,17 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Commands &#8212; yo v1.6.0 documentation</title>
+    <title>Commands &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Basic Commands" href="cmd00.html" />
-    <link rel="prev" title="Troubleshooting" href="../guide/troubleshooting.html" />
+    <link rel="prev" title="Multiple OCI Region Support in Yo" href="../guide/region.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
@@ -185,7 +185,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="../guide/troubleshooting.html" title="previous chapter">Troubleshooting</a></li>
+      <li>Previous: <a href="../guide/region.html" title="previous chapter">Multiple OCI Region Support in Yo</a></li>
       <li>Next: <a href="cmd00.html" title="next chapter">Basic Commands</a></li>
   </ul></li>
 </ul>

diff --git a/development.html b/development.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Development &#8212; yo v1.6.0 documentation</title>
+    <title>Development &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
-    <script src="_static/documentation_options.js?v=896c6380"></script>
+    <script src="_static/documentation_options.js?v=f8b929d9"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/yo.png"/>

diff --git a/genindex.html b/genindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; yo v1.6.0 documentation</title>
+    <title>Index &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
-    <script src="_static/documentation_options.js?v=896c6380"></script>
+    <script src="_static/documentation_options.js?v=f8b929d9"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/yo.png"/>

diff --git a/guide/block.html b/guide/block.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Block Volume Management &#8212; yo v1.6.0 documentation</title>
+    <title>Block Volume Management &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>
@@ -193,6 +193,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="vnc.html">VNC and Remote desktop</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Block Volume Management</a></li>
 <li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region.html">Multiple OCI Region Support in Yo</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../cmds/index.html">Commands</a></li>

diff --git a/guide/concepts.html b/guide/concepts.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Concepts &#8212; yo v1.6.0 documentation</title>
+    <title>Concepts &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>
@@ -173,6 +173,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="vnc.html">VNC and Remote desktop</a></li>
 <li class="toctree-l2"><a class="reference internal" href="block.html">Block Volume Management</a></li>
 <li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="region.html">Multiple OCI Region Support in Yo</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../cmds/index.html">Commands</a></li>

diff --git a/guide/configuration.html b/guide/configuration.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Configuration &#8212; yo v1.6.0 documentation</title>
+    <title>Configuration &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/guide/index.html b/guide/index.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>User Guide &#8212; yo v1.6.0 documentation</title>
+    <title>User Guide &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

diff --git a/guide/region.html b/guide/region.html
@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Multiple OCI Region Support in Yo &#8212; yo v1.6.0 documentation</title>
+    <title>Multiple OCI Region Support in Yo &#8212; yo v1.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=896c6380"></script>
+    <script src="../_static/documentation_options.js?v=f8b929d9"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>