Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: tutorial issue credential cloud agent issuer to edge agent holder #54

Merged
merged 67 commits into from
Oct 2, 2023

Conversation

goncalo-frade-iohk
Copy link
Contributor

@goncalo-frade-iohk goncalo-frade-iohk commented Sep 7, 2023

I think we need to gather opinions and create a template for this tutorials so we can provide the best content.
In this PR you can see that I organised the tutorial in Sections with Steps if needed, I did this because there is a lot of information and I felt just having steps is not enough.

Section 1

  • Step 1
  • Step 2
  • Step 3
  • etc

Section 2

Section 3

  • Step X
  • etc

Copy link
Contributor

@petevielhaber petevielhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Addressed styling/grammar
  • There will be additional structure changes needed once doc is completed

documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/tutorials/IssueCredential-CA-EA.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
Copy link
Contributor

@BS-IO BS-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @elribonazo - added some of my thoughts/recommendations.

documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
### Agent Deployment
In order to spin up a Prism Agent locally on your machine you must have docker installed as a requirement and its just required to clone the Prism Agent (building blocks) [repository](https://github.com/input-output-hk/atala-prism-building-blocks) and simply run the following command

For this guide we are going to be using a single tenant deployment with API Key authentication disabled. But detailed and more advanced configuration can be found in [Multi-Tenancy Management](/docs/atala-prism/prism-cloud-agent/multi-tenancy-management), [Authentication](/docs/atala-prism/prism-cloud-agent/authentication) and environment variables config [Environment Variables](/docs/atala-prism/prism-cloud-agent/environment-variables)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to make a comment about DIDs being on an in-memory ledger in this case? And perhaps something about their persistence?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check out what I added plz :)

documentation/docs/quick-start.md Outdated Show resolved Hide resolved
Comment on lines 163 to 390
1. API ENDPOINT
2. The [ConnectionId](/docs/quick-start#establish-a-connection-between-holder-and-prismagents) we created in previous step.
3. The Published [prism DID](/docs/quick-start#3-agent-configuration-steps-pre-requisities) we created in previous step.
4. The [schemaId](/docs/quick-start#3-agent-configuration-steps-pre-requisities) we created in previous step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest to replace with the above (and keep the links)

documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
@elribonazo elribonazo force-pushed the feature/ATL-5630 branch 2 times, most recently from 10dddc9 to 7b209ae Compare September 14, 2023 10:25
@lohanspies
Copy link
Contributor

Can we please change the curl examples in the markdown from http syntax to bash syntax so that they render properly in the markdown file?

@lohanspies
Copy link
Contributor

Can we please change the curl examples in the markdown from http syntax to bash syntax so that they render properly in the markdown file?

Fixed this already and committed the changes. I see we also use android for Android based code highlighting instead of java?

@lohanspies
Copy link
Contributor

Can we please change the curl examples in the markdown from http syntax to bash syntax so that they render properly in the markdown file?

Fixed this already and committed the changes. I see we also use android for Android based code highlighting instead of java?

Fixed

Can we please change the curl examples in the markdown from http syntax to bash syntax so that they render properly in the markdown file?

Fixed this already and committed the changes. I see we also use android for Android based code highlighting instead of java?

Fixed!

documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
Copy link
Contributor

@BS-IO BS-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments

documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Show resolved Hide resolved
Copy the `invitationUrl` and the `connectionId`.

### Establish a connection - Holder side

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Now that you have the invitation, it's time for the Holder to accept it.

documentation/docs/quick-start.md Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
documentation/docs/quick-start.md Outdated Show resolved Hide resolved
Copy link
Contributor

@BS-IO BS-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work all!

Copy link
Contributor

@elribonazo elribonazo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant work team the one accomplished here! Thanks everyone!

@BS-IO
Copy link
Contributor

BS-IO commented Sep 15, 2023

@elribonazo the build is failing, I think because some of the links are not resolving

cc @antonbaliasnikov

@BS-IO BS-IO marked this pull request as ready for review September 15, 2023 13:56
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would reconsider the arrows in this diagram.
From my understanding:

  1. Wallet SDK talks directly to the Agent.
  2. The Agent talks to the Wallet SDK through the Mediator.
  3. And the Controller, as per my understanding, is also a part of the Wallet SDK (you can call REST API from the SDK and subscribe to the events)

@elribonazo elribonazo merged commit 66fae41 into main Oct 2, 2023
4 checks passed
@elribonazo elribonazo deleted the feature/ATL-5630 branch October 2, 2023 14:00
atala-dev added a commit that referenced this pull request Oct 2, 2023
## [1.57.0](v1.56.0...v1.57.0) (2023-10-02)

### 🚀 New Content

* tutorial issue credential cloud agent issuer to edge agent holder ([#54](#54)) ([66fae41](66fae41))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.