Deployed 9243ef3 to main with MkDocs 1.5.3 and mike 2.0.0

main/UpdateRTD/index.html

@@ -2357,7 +2357,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

main/demo/AliceGetsAPhone/index.html

@@ -2223,7 +2223,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>
@@ -2332,7 +2332,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>

main/demo/Endorser/index.html

@@ -2260,12 +2260,12 @@ <h2 id="run-faber-as-an-author-with-a-dedicated-endorser-agent">Run Faber as an
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>./run_demo<span class="w"> </span>alice
 </code></pre></div>
 <p>You can run all of Faber's functions as normal - if you watch the console you will see that all ledger operations go through the endorser workflow.</p>
-<p>If you issue more than 5 credentials, you will see Faber creating a new revocation registry (encluding endorser operations).</p>
+<p>If you issue more than 5 credentials, you will see Faber creating a new revocation registry (including endorser operations).</p>
 <h2 id="run-alice-as-an-author-and-faber-as-an-endorser">Run Alice as an Author and Faber as an Endorser<a class="headerlink" href="#run-alice-as-an-author-and-faber-as-an-endorser" title="Permanent link">&para;</a></h2>
 <p>This approach sets up the endorser roles to allow manual testing using the agents' swagger pages:</p>
 <ul>
 <li>Faber runs as an Endorser (all of Faber's functions - issue credential, request proof, etc.) run normally, since Faber has ledger write access</li>
-<li>Alice starts up with a DID aith Author privileges (no ledger write access) and Faber is setup as Alice's Endorser</li>
+<li>Alice starts up with a DID with Author privileges (no ledger write access) and Faber is setup as Alice's Endorser</li>
 </ul>
 <p>Start a VON Network and a Tails server using the instructions above.</p>
 <p>Start up Faber as Endorser:</p>

main/demo/index.html

@@ -2617,7 +2617,7 @@ <h4 id="genesis-file-handling">Genesis File handling<a class="headerlink" href="
 <p>Assuming you followed our advice and are using a VON Network instance of Hyperledger Indy, you can ignore this section. If you started the Indy ledger <strong>without</strong> using VON Network, this information might be helpful.</p>
 </blockquote>
 <p>An Aries agent (or other client) connecting to an Indy ledger must know the contents of the <code>genesis</code> file for the ledger. The genesis file lets the agent/client know the IP addresses of the initial nodes of the ledger, and the agent/client sends ledger requests to those IP addresses. When using the <code>indy-sdk</code> ledger, look for the instructions in that repo for how to find/update the ledger genesis file, and note the path to that file on your local system.</p>
-<p>The envrionment variable <code>GENESIS_FILE</code> is used to let the Aries demo agents know the location of the genesis file. Use the path to that file as value of the <code>GENESIS_FILE</code> environment variable in the instructions below. You might want to copy that file to be local to the demo so the path is shorter.</p>
+<p>The environment variable <code>GENESIS_FILE</code> is used to let the Aries demo agents know the location of the genesis file. Use the path to that file as value of the <code>GENESIS_FILE</code> environment variable in the instructions below. You might want to copy that file to be local to the demo so the path is shorter.</p>
 <h4 id="run-a-local-postgres-instance">Run a local Postgres instance<a class="headerlink" href="#run-a-local-postgres-instance" title="Permanent link">&para;</a></h4>
 <p>The demo uses the postgres database the wallet persistence. Use the Docker Hub certified postgres image to start up a postgres instance to be used for the wallet storage:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>docker<span class="w"> </span>run<span class="w"> </span>--name<span class="w"> </span>some-postgres<span class="w"> </span>-e<span class="w"> </span><span class="nv">POSTGRES_PASSWORD</span><span class="o">=</span>mysecretpassword<span class="w"> </span>-d<span class="w"> </span>-p<span class="w"> </span><span class="m">5432</span>:5432<span class="w"> </span>postgres<span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;log_statement=all&#39;</span><span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;logging_collector=on&#39;</span><span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;log_destination=stderr&#39;</span>
@@ -2670,7 +2670,7 @@ <h4 id="issuing-and-proving-credentials">Issuing and Proving Credentials<a class
 <p>You don't need to do anything with Alice's agent - her agent is implemented to automatically receive credentials and respond to proof requests.</p>
 <p>Note there is an option "2a" to initiate a connectionless proof - you can execute this option but it will only work end-to-end when <a href="AliceGetsAPhone/">connecting to Faber from a mobile agent</a>.</p>
 <h2 id="additional-options-in-the-alicefaber-demo">Additional Options in the Alice/Faber demo<a class="headerlink" href="#additional-options-in-the-alicefaber-demo" title="Permanent link">&para;</a></h2>
-<p>You can enable support for various ACA-Py features by providing additional command-line arguements when starting up <code>alice</code> or <code>faber</code>.</p>
+<p>You can enable support for various ACA-Py features by providing additional command-line arguments when starting up <code>alice</code> or <code>faber</code>.</p>
 <p>Note that when the controller starts up the agent, it prints out the ACA-Py startup command with <em>all</em> parameters - you can inspect this command to see what parameters are provided in each case.  For more details on the parameters, just start ACA-Py with the <code>--help</code> parameter, for example:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>./scripts/run_docker start --help
 </code></pre></div>
@@ -2812,11 +2812,11 @@ <h3 id="multi-tenancy-with-mediation">Multi-tenancy <em>with Mediation</em>!!!<a
 <p>This works exactly as the <em>vanilla</em> multi-tenancy, except that all connections are mediated.</p>
 <h2 id="other-environment-settings">Other Environment Settings<a class="headerlink" href="#other-environment-settings" title="Permanent link">&para;</a></h2>
 <p>The agents run on a pre-defined set of ports, however occasionally your local system may already be using one of these ports.  (For example MacOS recently decided to use 8021 for the ftp proxy service.)</p>
-<p>To overriide the default port settings:</p>
+<p>To override the default port settings:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="nv">AGENT_PORT_OVERRIDE</span><span class="o">=</span><span class="m">8010</span><span class="w"> </span>./run_demo<span class="w"> </span>faber
 </code></pre></div>
 <p>(The agent requires up to 10 available ports.)</p>
-<p>To pass extra arguements to the agent (for example):</p>
+<p>To pass extra arguments to the agent (for example):</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="nv">DEMO_EXTRA_AGENT_ARGS</span><span class="o">=</span><span class="s2">&quot;[\&quot;--emit-did-peer-2\&quot;]&quot;</span><span class="w"> </span>./run_demo<span class="w"> </span>faber<span class="w"> </span>--did-exchange<span class="w"> </span>--reuse-connections
 </code></pre></div>
 <p>Additionally, separating the build and run functionalities in the script allows for smoother development and debugging processes. With the mounting of volumes from the host into the Docker container, code changes can be automatically reloaded without the need to repeatedly build the demo.</p>
@@ -2830,7 +2830,7 @@ <h2 id="learning-about-the-alicefaber-code">Learning about the Alice/Faber code<
 <p>These Alice and Faber scripts (in the <code>demo/runners</code> folder) implement the controller and run the agent as a sub-process (see the documentation for <code>aca-py</code>). The controller publishes a REST service to receive web hook callbacks from their agent. Note that this architecture, running the agent as a sub-process, is a variation on the documented architecture of running the controller and agent as separate processes/containers.</p>
 <p>The controllers for this demo can be found in the <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/main/demo/runners/alice.py">alice.py</a> and <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/main/demo/runners/faber.py">faber.py</a> files. Alice and Faber are instances of the agent class found in <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/main/demo/runners/support/agent.py">agent.py</a>.</p>
 <h2 id="openapi-swagger-demo">OpenAPI (Swagger) Demo<a class="headerlink" href="#openapi-swagger-demo" title="Permanent link">&para;</a></h2>
-<p>Developing an ACA-Py controller is much like developing a web app that uses a REST API. As you develop, you will want an easy way to test out the behaviour of the API. That's where the industry-standard OpenAPI (aka Swagger) UI comes in. ACA-Py (optionally) exposes an OpenAPI UI in ACA-Py that you can use to learn the ins and outs of the API. This <a href="AriesOpenAPIDemo/">Aries OpenAPI demo</a> shows how you can use the OpenAPI UI with an ACA-Py agent by walking through the connectiing, issuing a credential, and presenting a proof sequence.</p>
+<p>Developing an ACA-Py controller is much like developing a web app that uses a REST API. As you develop, you will want an easy way to test out the behaviour of the API. That's where the industry-standard OpenAPI (aka Swagger) UI comes in. ACA-Py (optionally) exposes an OpenAPI UI in ACA-Py that you can use to learn the ins and outs of the API. This <a href="AriesOpenAPIDemo/">Aries OpenAPI demo</a> shows how you can use the OpenAPI UI with an ACA-Py agent by walking through the connecting, issuing a credential, and presenting a proof sequence.</p>
 <h2 id="performance-demo">Performance Demo<a class="headerlink" href="#performance-demo" title="Permanent link">&para;</a></h2>
 <p>Another example in the <code>demo/runners</code> folder is <a href="https://github.com/hyperledger/aries-cloudagent-python/tree/main/demo/runners/performance.py">performance.py</a>, that is used to test out the performance of interacting agents. The script starts up agents for Alice and Faber, initializes them, and then runs through an interaction some number of times. In this case, Faber issues a credential to Alice 300 times.</p>
 <p>To run the demo, make sure that you shut down any running Alice/Faber agents. Then, follow the same steps to start the Alice/Faber demo, but:</p>
@@ -2843,7 +2843,7 @@ <h2 id="performance-demo">Performance Demo<a class="headerlink" href="#performan
 <p>You can also run the demo against a postgres database using the following:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a>./run_demo<span class="w"> </span>performance<span class="w"> </span>--arg-file<span class="w"> </span>demo/postgres-indy-args.yml
 </code></pre></div>
-<p>(Obvs you need to be running a postgres database - the command to start postgres is in the yml file provided above.)</p>
+<p>(Obviously you need to be running a postgres database - the command to start postgres is in the yml file provided above.)</p>
 <p>You can tweak the number of credentials issued using the <code>--count</code> and <code>--batch</code> parameters, and you can run against an Askar database using the <code>--wallet-type askar</code> option (or run using indy-sdk using <code>--wallet-type indy</code>).</p>
 <p>An example full set of options is:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a>./run_demo<span class="w"> </span>performance<span class="w"> </span>--arg-file<span class="w"> </span>demo/postgres-indy-args.yml<span class="w"> </span>-c<span class="w"> </span><span class="m">10000</span><span class="w"> </span>-b<span class="w"> </span><span class="m">10</span><span class="w"> </span>--wallet-type<span class="w"> </span>askar

main/features/AdminAPI/index.html

@@ -2436,7 +2436,7 @@ <h3 id="basic-message-received-basicmessages">Basic Message Received (<code>/bas
 <li><code>content</code>: the contents of the agent message</li>
 <li><code>state</code>: <code>received</code></li>
 </ul>
-<h3 id="forward-message-received-forward">Forward Message Received  (<code>/forward</code>)<a class="headerlink" href="#forward-message-received-forward" title="Permanent link">&para;</a></h3>
+<h3 id="forward-message-received-forward">Forward Message Received (<code>/forward</code>)<a class="headerlink" href="#forward-message-received-forward" title="Permanent link">&para;</a></h3>
 <p>Enable using <code>--monitor-forward</code>.</p>
 <ul>
 <li><code>connection_id</code>: the identifier of the connection associated with the recipient key</li>