Skip to content

Commit

Permalink
Automatic documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
brenns10 committed May 15, 2024
1 parent e7965ef commit 92c59a0
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 3 deletions.
3 changes: 3 additions & 0 deletions _sources/changelog.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ should appear here.
command line.
- Please see the documentation for a migration guide:
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.


## 1.6.0 - Wed, Apr 17, 2024

Expand Down
3 changes: 2 additions & 1 deletion _sources/guide/region.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ environment variable may be overridden by the command line option.

## Migrating yo.ini to multi-region support

Upon upgrading Yo, you may see the following warning:
Upon upgrading Yo to version 1.7.0 or later from any prior version, you may see
the following warning:

```
warning: region-specific configurations in [yo] section are deprecated, please update your config to use [regions.*] sections
Expand Down
15 changes: 15 additions & 0 deletions _sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,21 @@ but thankfully, this can be easily achieved with the command:
Follow the prompts to authenticate with your tenancy. If you don't know your
region, open the OCI Web UI and see what it defaults to.

Please note: if you encounter an error message in the above command which
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.
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".
3. Use "choose public key file" to upload the **public key** generated by step
1, and click submit. The resulting page should contain a fragment of
configuration file.
4. Paste the configuration fragment into ``~/.oci/config``. Be sure to set
``key_file`` to the name of your **private** key.

yo Configuration
~~~~~~~~~~~~~~~~

Expand Down
2 changes: 2 additions & 0 deletions changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ <h2>Unreleased<a class="headerlink" href="#unreleased" title="Link to this headi
https://oracle.github.io/yo/guide/region.html#migrating-yo-ini-to-multi-region-support</p></li>
</ul>
</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>
</ul>
</section>
<section id="wed-apr-17-2024">
Expand Down
3 changes: 2 additions & 1 deletion guide/region.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ <h2>Using multiple regions<a class="headerlink" href="#using-multiple-regions" t
</section>
<section id="migrating-yo-ini-to-multi-region-support">
<h2>Migrating yo.ini to multi-region support<a class="headerlink" href="#migrating-yo-ini-to-multi-region-support" title="Link to this heading"></a></h2>
<p>Upon upgrading Yo, you may see the following warning:</p>
<p>Upon upgrading Yo to version 1.7.0 or later from any prior version, you may see
the following warning:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">warning</span><span class="p">:</span> <span class="n">region</span><span class="o">-</span><span class="n">specific</span> <span class="n">configurations</span> <span class="ow">in</span> <span class="p">[</span><span class="n">yo</span><span class="p">]</span> <span class="n">section</span> <span class="n">are</span> <span class="n">deprecated</span><span class="p">,</span> <span class="n">please</span> <span class="n">update</span> <span class="n">your</span> <span class="n">config</span> <span class="n">to</span> <span class="n">use</span> <span class="p">[</span><span class="n">regions</span><span class="o">.*</span><span class="p">]</span> <span class="n">sections</span>
</pre></div>
</div>
Expand Down
15 changes: 15 additions & 0 deletions install.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,21 @@ <h3>OCI Configuration<a class="headerlink" href="#oci-configuration" title="Link
</div>
<p>Follow the prompts to authenticate with your tenancy. If you don’t know your
region, open the OCI Web UI and see what it defaults to.</p>
<p>Please note: if you encounter an error message in the above command which
contains the code <code class="docutils literal notranslate"><span class="pre">NotAuthorizedOrNotFound</span></code>, then there’s an alternative way
to setup your OCI credentials:</p>
<ol class="arabic simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">oci</span> <span class="pre">setup</span> <span class="pre">keys</span></code>. At the prompt, you probably want to type “N/A” to
avoid setting a passphrase for the key.</p></li>
<li><p>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”.</p></li>
<li><p>Use “choose public key file” to upload the <strong>public key</strong> generated by step
1, and click submit. The resulting page should contain a fragment of
configuration file.</p></li>
<li><p>Paste the configuration fragment into <code class="docutils literal notranslate"><span class="pre">~/.oci/config</span></code>. Be sure to set
<code class="docutils literal notranslate"><span class="pre">key_file</span></code> to the name of your <strong>private</strong> key.</p></li>
</ol>
</section>
<section id="yo-configuration">
<h3>yo Configuration<a class="headerlink" href="#yo-configuration" title="Link to this heading"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 92c59a0

Please sign in to comment.