Skip to content

Commit

Permalink
Merge pull request #29 from swcurran/master
Browse files Browse the repository at this point in the history
Links cleanup for the documentation
  • Loading branch information
swcurran authored Jul 1, 2019
2 parents 4e2dcbd + 0f9273d commit ffbac09
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DevReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ See the [README](README.md) for details about this repository and information ab

Aries Cloud Agent Python (ACA-Py) is a configurable, extensible, non-mobile Aries agent that implements an easy way for developers to build decentralized identity applications that use verifiable credentials.

The information on this page assumes you are developer with a background in decentralized identity, Indy, Aries and verifiable credentials. If you aren't familiar with those concepts and projects, please use our [Getting Started Guide](docs/gettingStartedAriesDev/README.md) to learn more.
The information on this page assumes you are developer with a background in decentralized identity, Indy, Aries and verifiable credentials. If you aren't familiar with those concepts and projects, please use our [Getting Started Guide](docs/GettingStartedAriesDev/README.md) to learn more.

## Installing

Instructions forthcoming. `aries_cloudagent` will be made available in the future as a python package at [pypi.org](https://pypi.org).

## Developer Demos

To put ACA-Py through its paces at the command line, checkout our [demos](docs/gettingStartedAriesDev/AriesDeveloperDemos.md) page.
To put ACA-Py through its paces at the command line, checkout our [demos](docs/GettingStartedAriesDev/AriesDeveloperDemos.md) page.

## Running

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As we create ACA-Py, we're building resources so that developers with a wide-ran

If you are experienced decentralized identity developer that knows Indy, is already familiar with the concepts behind Aries, and want to play with the code and perhaps start contributing, a traditional "install and go" page for developers can be found [here](DevReadMe.md).

For everyone else, we've created a [Getting Started Guide](docs/gettingStartedAriesDev/README.md) that will take you from knowing next to nothing about decentralized identity to developing Aries-based business apps and services in a hurry. Along the way, you'll run some early Indy apps, apps built on ACA-Py and developer-oriented demos for interacting with ACA-Py. The guide has a good table of contents so that you can skip the parts you already know.
For everyone else, we've created a [Getting Started Guide](docs/GettingStartedAriesDev/README.md) that will take you from knowing next to nothing about decentralized identity to developing Aries-based business apps and services in a hurry. Along the way, you'll run some early Indy apps, apps built on ACA-Py and developer-oriented demos for interacting with ACA-Py. The guide has a good table of contents so that you can skip the parts you already know.

We'll soon have a ReadTheDocs site published with docstrings extracted from the ACA-Py code.

Expand Down
2 changes: 1 addition & 1 deletion docs/GettingStartedAriesDev/DecentralizedIdentityDemos.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Link: [OrgBook BC - Production Instance](https://orgbook.gov.bc.ca/)

### The IIWBook Mobile Agent Demo

The IIWBook demo was presented during the [Internet Identity Workshop](https://internetidentityworkshop.com/) (IIW) 28. The demo uses instances of the Aries Cloud Agent - Python-based services interacting with a mobile agent to issue and verify credentials. Follow along with the demo to get a beta Indy mobile agent from Streetcred, use it to get a verifiable credential that you control your email address, and proof the claims from that credential to get a verifiable credential that you attended IIW (or at least added attended a demo presented at IIW).
The IIWBook demo was presented during the [Internet Identity Workshop](https://internetidentityworkshop.com/) (IIW) 28. The demo uses instances of the Aries Cloud Agent - Python-based services interacting with a mobile agent to issue and verify credentials. Follow along with the demo to get a beta Indy mobile agent from [Streetcred](https://app.streetcred.id/), use it to get a verifiable credential that you control your email address, and proof the claims from that credential to get a verifiable credential that you attended IIW (or at least added attended a demo presented at IIW).

Link: [IIWBook Demo](https://vonx.io/how_to/iiwbook)

Expand Down
10 changes: 5 additions & 5 deletions docs/GettingStartedAriesDev/IndyAriesDevOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

Now that you know the basics of the Indy/Aries eco-system, what do you want to work on? There are many projects at different levels of the eco-system you could choose to work on, and many ways to contribute to the community.

This is an important summary for newcomers, as often the temptation is to start at a level far below where you plan to focus your attention. Too often people coming into the community start at "the blockchain" - at `indy-node` (the Indy public ledger) or the `indy-sdk`. That is far below where the majority of developers will work and is not really that helpful if you want to build applications.
This is an important summary for newcomers, as often the temptation is to start at a level far below where you plan to focus your attention. Too often devs coming into the community start at "the blockchain"; at `indy-node` (the Indy public ledger) or the `indy-sdk`. That is far below where the majority of developers will work and is not really that helpful if what you really want to do is build decentralized identity applications.

We'll go through the layers from top of the stack to the bottom. Our expectation is that the majority of developers will work at the application level, and there will be fewer contributing developers each layer down the stack you go. This is not to dissuade anyone from contributing at the lower levels, but rather to say if you are not going to contribute at the lower levels, you don't need to everything about it. It's much like web development - you don't need to know TCP/IP to build web apps.
In the following, we go through the layers from the top of the stack to the bottom. Our expectation is that the majority of developers will work at the application level, and there will be fewer contributing developers each layer down the stack you go. This is not to dissuade anyone from contributing at the lower levels, but rather to say if you are not going to contribute at the lower levels, you don't need to everything about it. It's much like web development - you don't need to know TCP/IP to build web apps.

## Building Decentralized Identity Applications

If you just want to build enterprise applications on top of the decentralized identity-related Hyperledger projects, you can start with building cloud-based controller apps using any language you want, and deploying your code with an instance of the code in this repository ([aries-cloudagent-python](https://github.com/hyperledger/aries-cloudagent-python)).

If you want to build a mobile agent, there are open source options available, or you can use something like [Streetcred's] [Agent Framework](http://github.com/streetcred-id/agent-framework).
If you want to build a mobile agent, there are open source options available, such as [Mattr Global](https://mattr.global/)'s [OSMA](https://github.com/mattrglobal/osma), or you can use something like [Streetcred's](https://app.streetcred.id/) [Agent Framework](http://github.com/streetcred-id/agent-framework) as the basis for your own mobile agent.

As a developer building applications that use/embed Aries agents, you should be monitoring the [Aries Working Group](https://wiki.hyperledger.org/display/ARIES/Aries+Working+Group) activities and the [aries-rfcs](https://github.com/hyperledger/aries-rfcs) repo to see what protocols are being added and extended. In some cases, you may need to create your own protocols to be added to this repository, and you should do that in an open way, involving the community.
As a developer building applications that use/embed Aries agents, you should join the [Aries Working Group](https://wiki.hyperledger.org/display/ARIES/Aries+Working+Group)'s weekly calls and watch the [aries-rfcs](https://github.com/hyperledger/aries-rfcs) repo to see what protocols are being added and extended. In some cases, you may need to create your own protocols to be added to this repository, and if you are looking for interoperability, you should specify those protocols in an open way, involving the community.

Note that if this is what you want to do, you don't need to do a deep dive into the Aries SDK, the Indy SDK or the Indy Node public ledger.
Note that if building apps is what you want to do, you don't need to do a deep dive into the Aries SDK, the Indy SDK or the Indy Node public ledger. You need to know the concepts, but it's not a requirement that know the code base intimately.

## Contributing to `aries-cloudagent-python`

Expand Down
2 changes: 1 addition & 1 deletion docs/GettingStartedAriesDev/IndyBasics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Indy, Verifiable Credentials and Decentralized Identity Basics

> **NOTE:** If you are developer building apps on top of Aries and Indy, you **DO NOT** need to know the nuts and bolts of Indy to build applications. You need to know about verifiable credentials and the concepts of self-soveriegn identity. But as an app developer, you don't need to do the Indy getting started pieces. Aries takes care of those details for you.
> **NOTE:** If you are developer building apps on top of Aries and Indy, you **DO NOT** need to know the nuts and bolts of Indy to build applications. You need to know about verifiable credentials and the concepts of self-soveriegn identity. But as an app developer, you don't need to do the Indy getting started pieces. Aries takes care of those details for you. The introduction linked here should be sufficient.
If you are new to Indy and verifiable credentials and want to learn the core concepts, this [link](https://github.com/hyperledger/education/blob/master/LFS171x/docs/introduction-to-hyperledger-indy.md) provides a solid foundation into the goals and purpose of Indy including verifiable credentials, DIDs, decentralized/self-sovereign identity, the Sovrin Foundation and more. The document is the content of the Indy chapter of the Hyperledger edX [Blockchain for Business](https://www.edx.org/course/blockchain-for-business-an-introduction-to-hyperledger-technologies) course (which you could also go through).

Expand Down

0 comments on commit ffbac09

Please sign in to comment.