Skip to content

Commit

Permalink
Alter Aries doc refs
Browse files Browse the repository at this point in the history
Signed-off-by: Lucas ONeil <[email protected]>
  • Loading branch information
loneil committed Oct 22, 2024
1 parent aeb7245 commit 02e1e8a
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

## What is Traction?

Traction is a digital wallet solution comprised of plugins layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.
Traction is a digital wallet solution comprised of plugins layered on top of OpenWallet Foundation ACA-Py and streamlines the process of sending and receiving digital credentials for governments and organizations.

Its open-source foundation makes it easy to integrate digital trust technology into existing lines of business applications, without having to stand up, maintain and manage an instance of ACA-Py themselves. Future functionality could include machine-readable governance and more.

Expand All @@ -43,7 +43,7 @@ Establish your own Traction tenant in a B.C. Government sandbox to issue, hold,
Traction makes it easier to integrate digital trust technology into existing line of business applications.

- **API-first Architecture**: Traction is designed with an API-first architecture, this RESTful API allows for integration into existing line-of-business applications already being used by organizations, the Tenant user interface is built on this API to enable adoption prior to integration and for low-use functions.
- **Enhanced Interoperability**: Hyperledger Aries makes Traction more broadly compatible with existing technologies used by governments and organizations around the world.
- **Enhanced Interoperability**: OWF ACA-Py makes Traction more broadly compatible with existing technologies used by governments and organizations around the world.
- **Multi-tenancy**: Rather than having multiple digital tools to integrate with organizations, one scalable instance of Traction can be used to participate in the digital trust ecosystem, control all connections, and more easily share data.
- **Higher Scalability**: Traction is open-source technology, encouraging collaborative refinement, faster release, and higher scalability.

Expand Down Expand Up @@ -111,4 +111,4 @@ Traction is licensed under Apache License 2.0 which can be reviewed [here](./LIC
## Engage with the community

Connect with others
- for Aries discussion see the Hyperlerger Aries Github [participation section](https://github.com/hyperledger/aries#project-participation)
- for ACA-Py discussion see the OWF ACA-Py Github [for links to discussion forums](https://github.com/openwallet-foundation/acapy?tab=readme-ov-file#troubleshooting)
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Traction Documentation and Resources

## A Traction Sandbox Hyperledger Aries/AnonCreds Workshop
## A Traction Sandbox ACA-Py/AnonCreds Workshop

This workshop contains a sequence of labs demonstrating issuing, receiving,
holding, requesting, presenting, and verifying AnonCreds Verifiable
Credentials--no technical experience required! The labs take about 20 minutes
for complete. New developers expecting to build an Issuer or Verifier with
[Traction] or [Aries Cloud Agent Python] will find this a great place to
[Traction] or [ACA-Py] will find this a great place to
start--with developer-oriented "Next Steps" suggested at the end of the
Workshop.

[Traction]: https://digital.gov.bc.ca/digital-trust/technical-resources/traction/
[Aries Cloud Agent Python]: https://aca-py.org
[ACA-Py]: https://aca-py.org

## Basic Architecture Overview
See [traction flow chart](assets/traction-flow-chart-1600x900-12162022.pdf)
Expand Down
4 changes: 2 additions & 2 deletions docs/traction-anoncreds-workshop.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# A Traction Sandbox Hyperledger Aries/AnonCreds Workshop
# A Traction Sandbox ACA-Py/AnonCreds Workshop

Find the Traction AnonCreds workshop in its new home at [Hyperledger Aries ACA-Py Docs](https://aca-py.org/latest/demo/ACA-Py-Workshop/).
Find the Traction AnonCreds workshop in its new home at [ACA-Py Docs](https://aca-py.org/latest/demo/ACA-Py-Workshop/).
4 changes: 2 additions & 2 deletions plugins/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Traction Aca-Py Plugins

Traction is a set of plugins that facilitate multi-tenant management within [Aca-Py](https://github.com/hyperledger/aries-cloudagent-python). Some of the plugins ([basicmessage_storage](./basicmessage_storage/README.md), [connection_update](./connection_update/README.md) and [multitenant_provider](./multitenant_provider/README.md)) can be used independently from Traction.
Traction is a set of plugins that facilitate multi-tenant management within [Aca-Py](https://github.com/openwallet-foundation/acapy). Some of the plugins ([basicmessage_storage](./basicmessage_storage/README.md), [connection_update](./connection_update/README.md) and [multitenant_provider](./multitenant_provider/README.md)) can be used independently from Traction.


### Developing Aca-Py Plugins

Please refer to [Getting Started Aries Development: Plugins](https://github.com/hyperledger/aries-cloudagent-python/blob/45c832658245747a3366735f6179362d127bae02/docs/GettingStartedAriesDev/PlugIns.md) for an in depth look at how to build Aca-Py plugins and how they operate within Aca-Py.
Please refer to [Features: Plugins](https://github.com/openwallet-foundation/acapy/blob/main/docs/features/PlugIns.md) for an in depth look at how to build Aca-Py plugins and how they operate within Aca-Py.
2 changes: 1 addition & 1 deletion scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Currently this setup has dependencies on BCovrin Test Ledger and a registered en
Also, there are longer term goals for moving the plugins to separate repositories and allowing teams to pull them in and configure their own Aca-Py images as needed. Currently, we are pulling the plugins in as source and building a custom image. For local development, the build of this image is included in the `docker compose build` command. Once the Aca-py + plugin image is built (tagged: `traction:plugins-acapy`), that image is pulled into another that we use to run an [ngrok](https://ngrok.com) script for external access to our agent (see [services/aca-py](../services/aca-py). This is not what we are doing in production, but we are doing it here (for now).

#### traction:plugins-acapy
This image is based on [ghcr.io/hyperledger/aries-cloudagent-python:py3.9-0.12.1](https://github.com/hyperledger/aries-cloudagent-python/releases/tag/0.12.1) and this is where we pull in the [traction plugins](../plugins) and build out the image see [Dockerfile](../plugins/docker/Dockerfile)
This image is based on [ghcr.io/openwallet-foundation/acapy-agent:py3.12-1.1.0](https://github.com/openwallet-foundation/acapy/releases/tag/1.1.0) and this is where we pull in the [traction plugins](../plugins) and build out the image see [Dockerfile](../plugins/docker/Dockerfile)

The plugins are built using the base plugins [pyproject.toml](../plugins/pyproject.toml) which pulls in each plugin as source. Simply adding new plugin directories to the file system and adding to the dockerfile will not be enough, they must be dependencies in the `plugins/pyproject.toml`.

Expand Down

0 comments on commit 02e1e8a

Please sign in to comment.