Skip to content

Commit

Permalink
Deployed 789b2e3 to v0.12.1 with MkDocs 1.6.0 and mike 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed May 2, 2024
1 parent c0d385c commit 9b9dc29
Show file tree
Hide file tree
Showing 72 changed files with 359 additions and 216 deletions.
2 changes: 1 addition & 1 deletion v0.12.1/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
154 changes: 147 additions & 7 deletions v0.12.1/CHANGELOG/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion v0.12.1/CODE_OF_CONDUCT/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/CONTRIBUTING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/MAINTAINERS/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
13 changes: 8 additions & 5 deletions v0.12.1/PUBLISHING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2272,7 +2272,7 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
</li>
<li>
<p>Update the ReadTheDocs in the <code>/docs</code> folder by following the instructions in
the <code>./README.md</code> file. That will likely add a number of new and modified
the <code>./UpdateRTD.md</code> file. That will likely add a number of new and modified
files to the PR. Eliminate all of the errors in the generation process,
either by mocking external dependencies or by fixing ACA-Py code. If
necessary, create an issue with the errors and assign it to the appropriate
Expand All @@ -2297,6 +2297,9 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
<p>Regenerate openapi.json and swagger.json by running
<code>../scripts/generate-open-api-spec</code> from within the <code>aries_cloudagent</code> folder.</p>
</li>
</ul>
<p>Command: <code>cd aries_cloudagent;../scripts/generate-open-api-spec;cd ..</code></p>
<ol>
<li>
<p>Double check all of these steps above, and then submit a PR from the branch.
Add this new PR to CHANGELOG.md so that all the PRs are included.
Expand All @@ -2308,21 +2311,21 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
<li>
<p>Immediately after it is merged, create a new GitHub tag representing the
version. The tag name and title of the release should be the same as the
version in <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/0.12.0/pyproject.toml">pyproject.toml</a>. Use
version in <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/0.12.1/pyproject.toml">pyproject.toml</a>. Use
the "Generate Release Notes" capability to get a sequential listing of the
PRs in the release, to complement the manually curated Changelog. Verify on
PyPi that the version is published.</p>
</li>
<li>
<p>New images for the release are automatically published by the GitHubAction
Workflows: <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0/.github/workflows/publish.yml">publish.yml</a> and <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0/.github/workflows/publish-indy.yml">publish-indy.yml</a>. The actions are triggered
Workflows: <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish.yml">publish.yml</a> and <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/.github/workflows/publish-indy.yml">publish-indy.yml</a>. The actions are triggered
when a release is tagged, so no manual action is needed. The images are
published in the <a href="https://github.com/orgs/hyperledger/packages?repo_name=aries-cloudagent-python">Hyperledger Package Repository under
aries-cloudagent-python</a>
and a link to the packages added to the repositories main page (under
"Packages").</p>
</li>
</ul>
</ol>
<p>Additional information about the container image publication process can be
found in the document <a href="../deploying/ContainerImagesAndGithubActions/">Container Images and Github Actions</a>.</p>
<ol>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/SECURITY/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
4 changes: 2 additions & 2 deletions v0.12.1/UpdateRTD/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2366,7 +2366,7 @@ <h3 id="generate-module-files">Generate Module Files<a class="headerlink" href="
<p>To rebuild the project and settings from scratch (you'll need to move the generated index file up a level):</p>
<p><code>rm -rf generated; sphinx-apidoc -f -M -o ./generated ../aries_cloudagent/ $(find ../aries_cloudagent/ -name '*tests*')</code></p>
<p>Note that the <code>find</code> command that is used to exclude any of the <code>test</code> python files from the RTD documentation.</p>
<p>Check the <code>git status</code> in your repo to see if the generator updates, adds or removes any existing RTD modules.</p>
<p>Check the <code>git status</code> in your repo to see if the generator updates, adds or removes any existing RTD modules.</p>
<h3 id="reviewing-the-files-locally">Reviewing the files locally<a class="headerlink" href="#reviewing-the-files-locally" title="Permanent link">&para;</a></h3>
<p>To auto-generate the module documentation locally run:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>sphinx-build<span class="w"> </span>-b<span class="w"> </span>html<span class="w"> </span>-a<span class="w"> </span>-E<span class="w"> </span>-c<span class="w"> </span>./<span class="w"> </span>./<span class="w"> </span>./_build
Expand Down
4 changes: 2 additions & 2 deletions v0.12.1/aca-py.org/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2246,7 +2246,7 @@ <h2 id="code-internals-documentation">Code Internals Documentation<a class="head
<p>In addition to this documentation site, the ACA-Py community also maintains an
ACA-Py internals documentation site. The internals documentation consists of the
<code>docstrings</code> extracted from the ACA-Py Python code and covers all of the
(non-test) modules in the codebase. Check it out on the <a href="https://aries-cloud-agent-python.readthedocs.io/en/0.12.0">Aries Cloud
(non-test) modules in the codebase. Check it out on the <a href="https://aries-cloud-agent-python.readthedocs.io/en/0.12.1">Aries Cloud
Agent-Python ReadTheDocs site</a>.
As with this site, the ReadTheDocs documentation is version specific.</p>
<p>Got questions?</p>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/demo/AcmeDemoWorkshop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
6 changes: 3 additions & 3 deletions v0.12.1/demo/AliceGetsAPhone/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2232,7 +2232,7 @@ <h4 id="install-ngrok-and-jq">Install ngrok and jq<a class="headerlink" href="#i
<p>You can download jq releases <a href="https://github.com/stedolan/jq/releases">here</a></p>
<h4 id="expose-services-publicly-using-ngrok">Expose services publicly using ngrok<a class="headerlink" href="#expose-services-publicly-using-ngrok" title="Permanent link">&para;</a></h4>
<p>Note that this is <em>only required when running docker on your local machine</em>. When you run on PWD a public endpoint for your agent is exposed automatically.</p>
<p>Since the mobile agent will need some way to communicate with the agent running on your local machine in docker, we will need to create a publicly accesible url for some services on your machine. The easiest way to do this is with <a href="https://ngrok.com/">ngrok</a>. Once ngrok is installed, create a tunnel to your local machine:</p>
<p>Since the mobile agent will need some way to communicate with the agent running on your local machine in docker, we will need to create a publicly accessible url for some services on your machine. The easiest way to do this is with <a href="https://ngrok.com/">ngrok</a>. Once ngrok is installed, create a tunnel to your local machine:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>ngrok<span class="w"> </span>http<span class="w"> </span><span class="m">8020</span>
</code></pre></div>
<p>This service is used for your local aca-py agent - it is the endpoint that is advertised for other Aries agents to connect to.</p>
Expand Down Expand Up @@ -2341,7 +2341,7 @@ <h2 id="issue-a-credential">Issue a Credential<a class="headerlink" href="#issue
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>Faber | Credential revocation ID: 1
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a>Faber | Credential: state = done, cred_ex_id = ba3089d6-92da-4cb7-9062-7f24066b2a2a
</code></pre></div>
<p>The revocation registry id and credential revocation id only appear if revocation is active. If you are doing revocation, you to need the <code>Revocation registry id</code> later, so we recommend that you copy it it now and paste it into a text file or someplace that you can access later. If you don't write it down, you can get the Id from the Admin API using the <strong><code>GET /revocation/active-registry/{cred_def_id}</code></strong> endpoint, and passing in the credential definition Id (which you can get from the <strong><code>GET /credential-definitions/created</code></strong> endpoint).</p>
<p>The revocation registry id and credential revocation id only appear if revocation is active. If you are doing revocation, you to need the <code>Revocation registry id</code> later, so we recommend that you copy it it now and paste it into a text file or some place that you can access later. If you don't write it down, you can get the Id from the Admin API using the <strong><code>GET /revocation/active-registry/{cred_def_id}</code></strong> endpoint, and passing in the credential definition Id (which you can get from the <strong><code>GET /credential-definitions/created</code></strong> endpoint).</p>
<h3 id="accept-the-credential">Accept the Credential<a class="headerlink" href="#accept-the-credential" title="Permanent link">&para;</a></h3>
<p>The credential offer should automatically show up in the mobile agent. Accept the offered credential following the instructions provided by the mobile agent. That will look something like this:</p>
<details>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/demo/AliceWantsAJsonCredential/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
4 changes: 2 additions & 2 deletions v0.12.1/demo/Aries-Workshop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2778,7 +2778,7 @@ <h3 id="whats-next-experiment-with-an-issuer-web-app">What's Next: Experiment Wi
application. To get an idea of what that will entail, we're delighted to direct
you to a very simple Web App that one of your predecessors on this same journey
created (and contributed!) to learn more about using the Traction OpenAPI in a
very simple Web App. Checkout this <a href="https://github.com/hyperledger/aries-acapy-controllers/tree/0.12.0/TractionIssuanceDemo">Traction Issuance Demo</a> and try it out
very simple Web App. Checkout this <a href="https://github.com/hyperledger/aries-acapy-controllers/tree/0.12.1/TractionIssuanceDemo">Traction Issuance Demo</a> and try it out
yourself, with your Sandbox tenant. Once you review the code, you should have an
excellent idea of how you can add these same capabilities to your line of
business application.</p>
Expand Down
2 changes: 1 addition & 1 deletion v0.12.1/demo/AriesOpenAPIDemo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down
4 changes: 2 additions & 2 deletions v0.12.1/demo/AriesPostmanDemo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">

You are viewing the documentation for ACA-Py Release, 0.12.0.
You are viewing the documentation for ACA-Py Release 0.12.1.

</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
Expand Down Expand Up @@ -2518,7 +2518,7 @@ <h3 id="installing-postman">Installing Postman<a class="headerlink" href="#insta
<h3 id="creating-a-workspace">Creating a workspace<a class="headerlink" href="#creating-a-workspace" title="Permanent link">&para;</a></h3>
<p>Create a new postman workspace labeled "acapy-demo".</p>
<h3 id="importing-the-environment">Importing the environment<a class="headerlink" href="#importing-the-environment" title="Permanent link">&para;</a></h3>
<p>In the environment tab from the left, click the import button. You can paste this <a href="https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json">link</a> which is the <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0/demo/postman/environment.json">environment file</a> in the ACA-Py repository.</p>
<p>In the environment tab from the left, click the import button. You can paste this <a href="https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json">link</a> which is the <a href="https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.1/demo/postman/environment.json">environment file</a> in the ACA-Py repository.</p>
<p>Make sure you have the environment set as your active environment.</p>
<h3 id="importing-the-collections">Importing the collections<a class="headerlink" href="#importing-the-collections" title="Permanent link">&para;</a></h3>
<p>In the collections tab from the left, click the import button.</p>
Expand Down
Loading

0 comments on commit 9b9dc29

Please sign in to comment.