diff --git a/README_TECHDOCS.md b/README_TECHDOCS.md index beaf1fc..e8b83ba 100644 --- a/README_TECHDOCS.md +++ b/README_TECHDOCS.md @@ -1,9 +1,9 @@ [![Package Status](https://github.com/bcgov/DITP/actions/workflows/publish.yaml/badge.svg)](https://github.com/bcgov/DITP/actions/workflows/publish.yaml) -# digital-trust-documentation +# common-hosted-digital-credential-service-documentation -Technical and non-technical documentation for Digital Trust and Verifiable Credentials +Technical and non-technical documentation for the Common Hosted Digital Credential Service ## About diff --git a/catalog-info.yaml b/catalog-info.yaml index f4b1dda..b4ff3a3 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -2,9 +2,8 @@ apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: digital-trust - title: Digital Trust - description: Technical and non-technical documentation for Digital Trust and - Verifiable Credentials + title: Common Hosted Digital Credential Service + description: Technical and non-technical documentation for the Common Hosted Digital Credential Service annotations: github.com/project-slug: bcgov/DITP backstage.io/techdocs-ref: dir:. diff --git a/docs/about-us.md b/docs/about-us.md index 3a0159a..eb64cdc 100644 --- a/docs/about-us.md +++ b/docs/about-us.md @@ -2,4 +2,4 @@ Learn more about Digital Trust initiatives in the BC provincial Government at https://digital.gov.bc.ca/digital-trust/home/ -For any questions or requests that are not answered in the documentation or on the Digital trust website, feel free to log an issue in this repository and/or send an email at the addresses listed [here](https://digital.gov.bc.ca/digital-trust/contact). +For any questions or requests that are not answered in the documentation or on the Digital Trust website, feel free to log an issue in this repository and/or send an email at the addresses listed [here](https://digital.gov.bc.ca/digital-trust/contact). diff --git a/docs/acapy-integration-howto.md b/docs/acapy-integration-howto.md index 6ccb95c..8a6f085 100644 --- a/docs/acapy-integration-howto.md +++ b/docs/acapy-integration-howto.md @@ -1,6 +1,6 @@ # Integration How-To -Implementing a custom integration with an ACA-Py/Traction agent is fairly straightforward: the agent exposes a set of REST APIs that cover all of the Digital trust functionality that may be implemented. There are, however, some concepts that need to be considered when making requests to these endpoints. This page outlines some of the most important concepts and "gotchas" that need to be considered. +Implementing a custom integration with an ACA-Py/Traction agent is fairly straightforward: the agent exposes a set of REST APIs that cover all of the Common Digital Credential Service functionality that may be implemented. There are, however, some concepts that need to be considered when making requests to these endpoints. This page outlines some of the most important concepts and "gotchas" that need to be considered. ## Authentication diff --git a/docs/index.md b/docs/index.md index 45204c0..0ee4e44 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@ -# Digital Trust +# Common Hosted Digital Credential Service Technical and non-technical documentation for Digital Trust and Verifiable Credentials -## About Digital Trust (DT) +## About the Common Hosted Digital Credential Service -Digital Trust is part of the Cybersecurity and Digital Trust (CDT) team at the Province of British Columbia. +The Common Hosted Digital Credential Service is part of the Cybersecurity and Digital Trust (CDT) team at the Province of British Columbia. Our focus is building tools to enable Digital Trust and supporting partners/adopter in their journey to improve their business processes and implement new ones that leverage this technology. @@ -21,5 +21,5 @@ There are three main patterns that can be leveraged in the Digital Trust space, Depending on which pattern you are looking to implement, the following solutions will provide a foundation to get started: - [VC-AuthN and SSO](solutions/vc-authn-sso.md): a solution that allows the use of Digital Credentials in an OIDC authentication flow. As an identity Provider service integrated with the [Pathfinder SSO Service](https://developer.gov.bc.ca/docs/default/component/css-docs) it provides a lightweight, standard approach to web application authentication that does not require deep knowledge of Digital trust patterns and tools. -- [Traction](solutions/traction-overview.md): a Software-As-A-Service Enterprise agent service based on [Aries Cloudagent Python](https://github.com/hyperledger/aries-cloudagent-python), it provides streamlined onboarding for new adopters wanting to have full control over their Digital trust processes, from receiving and presenting Digital credentials to acting as a verifier or even an issuer. +- [Traction](solutions/traction-overview.md): a Software-As-A-Service Enterprise agent service based on [ACA-Py](https://github.com/openwallet-foundation/aries-cloudagent-python), it provides streamlined onboarding for new adopters wanting to have full control over their Digital Trust processes, from receiving and presenting Digital credentials to acting as a verifier or even an issuer. - [OrgBook BC](solutions/orgbook-bc.md): a repository of credentials for publicly available information. It contains information about entities registered as businesses in BC (data from BC registries), as well as [other permit/license credentials from different organizations](https://orgbook.gov.bc.ca/about/orgbook-data). diff --git a/docs/patterns/access.md b/docs/patterns/access.md index 15be382..a6a45a9 100644 --- a/docs/patterns/access.md +++ b/docs/patterns/access.md @@ -1,6 +1,6 @@ # Access -In the access pattern, a system will require users to prove that they can access its functionalities by presenting information contained in one or more verifiable credentials. Depending on the needs of each integration, there are two ways to enable Digital trust Access in your application: +In the access pattern, a system will require users to prove that they can access its functionalities by presenting information contained in one or more verifiable credentials. Depending on the needs of each integration, there are two ways to enable Digital Trust Access in your application: - OIDC based access - Direct access diff --git a/docs/solutions/endorser-service.md b/docs/solutions/endorser-service.md index 4763b67..92d0d70 100644 --- a/docs/solutions/endorser-service.md +++ b/docs/solutions/endorser-service.md @@ -2,7 +2,7 @@ An Endorser Service is responsible for authorizing write transactions to each one of the ledgers supported by BCGov. An overview of the ledgers available in read/write mode can be found [here](traction-overview.md#ledgers). -When a write operation such as publishing a new schema definition to the ledger is required, tenant administrators will need to request authorization to the Digital trust team. Each request for endorsement will be reviewed and, if the governance terms are respected, will be approved. +When a write operation such as publishing a new schema definition to the ledger is required, tenant administrators will need to request authorization to the Digital Trust team. Each request for endorsement will be reviewed and, if the governance terms are respected, will be approved. !!! info "Note" Endorsement requests in the `dev` environment will be automatically approved in order to facilitate rapid prototyping and development of new solutions, once a connection with the endorser agent is established. `test` and `prod`, however, will require a DITP member to review the request and approve it before the transaction can be written and completed. diff --git a/docs/solutions/traction-becoming-an-issuer.md b/docs/solutions/traction-becoming-an-issuer.md index f8da8bd..520ac33 100644 --- a/docs/solutions/traction-becoming-an-issuer.md +++ b/docs/solutions/traction-becoming-an-issuer.md @@ -2,7 +2,7 @@ Becoming an issuer in Traction will provide you with the ability of "rooting" your agent on a ledger in write mode, and start publishing schemas and credential definitions, and therefore issue your own credentials. -Becoming an issuer involves accepting the Governance built around Digital credentials, and obtaining approval for publishing new schemas/credential definitions. This conversation can be initiated with the Digital trust team when requesting a new tenant or any time afterwards. +Becoming an issuer involves accepting the Governance built around Digital credentials, and obtaining approval for publishing new schemas/credential definitions. This conversation can be initiated with the Digital Trust team when requesting a new tenant or any time afterwards. For Governance questions, please refer to https://github.com/bcgov/bc-vcpedia . Once approval is obtained, it will be possible to select which ledger to connect to in write mode from the `Profile` section of your tenant. @@ -13,7 +13,7 @@ Once approval is obtained, it will be possible to select which ledger to connect When becoming an issuer, the agent will be connected with the role of `author` to an `endorser` who is responsible for "supporting" write transactions from authors. -Endorsement requests are reviewed by the Digital Trust team and acted upon based on the published Governance. The Digital trust team may request adjustments in naming or other schema/credential definition settings in order to approve an endorsement request. +Endorsement requests are reviewed by the Digital Trust team and acted upon based on the published Governance. The Digital Trust team may request adjustments in naming or other schema/credential definition settings in order to approve an endorsement request. !!! info "Note" It is generally allowed to publish new schemas and credential definitions in the development environment. Test and Production are gated behind an endorser that respects the published Governance. \ No newline at end of file diff --git a/docs/solutions/traction-overview.md b/docs/solutions/traction-overview.md index 9236e1f..2a0e234 100644 --- a/docs/solutions/traction-overview.md +++ b/docs/solutions/traction-overview.md @@ -2,7 +2,7 @@ ## What is Traction -[Traction](https://github.com/bcgov/traction) is an application built on top of [Aries Cloudagent Python](https://github.com/hyperledger/aries-cloudagent-python) to facilitate the provisioning and management of tenant agents. With Traction, the DITP team does not need to prepare and deploy new agent instances for each adopter: users submit a request for a tenant and are able to self check-in and manage their settings when approved. +[Traction](https://github.com/bcgov/traction) is an application built on top of [ACA-Py](https://github.com/openwallet-foundation/aries-cloudagent-python) to facilitate the provisioning and management of tenant agents. With Traction, the DITP team does not need to prepare and deploy new agent instances for each adopter: users submit a request for a tenant and are able to self check-in and manage their settings when approved. ## Tenants diff --git a/docs/solutions/vc-authn-sso.md b/docs/solutions/vc-authn-sso.md index 2089d30..8549668 100644 --- a/docs/solutions/vc-authn-sso.md +++ b/docs/solutions/vc-authn-sso.md @@ -2,7 +2,7 @@ [VC-AuthN OIDC](https://github.com/bcgov/vc-authn-oidc) is an identity provider compatible with the OpenID Connect protocol, that uses Verifiable credentials as authentication method. -The service is composed of an agent ([ACA-Py](https://github.com/hyperledger/aries-cloudagent-python)) that is responsible for the secure communication and exchange nd credentials, and a controller that "drives" the agent to build authentication requests and translate them into the OIDC protocol. +The service is composed of an agent ([ACA-Py](https://github.com/openwallet-foundation/aries-cloudagent-python)) that is responsible for the secure communication and exchange nd credentials, and a controller that "drives" the agent to build authentication requests and translate them into the OIDC protocol. ## Getting Started diff --git a/mkdocs.yml b/mkdocs.yml index 8c1289f..dfac85a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: "Digital Trust" -site_description: "Technical and non-technical documentation for Digital Trust and Verifiable Credentials" +site_name: "Common Hosted Digital Credential Service" +site_description: "Technical and non-technical documentation for the Common Hosted Digital Credential Service" docs_dir: "docs" repo_url: "https://github.com/bcgov/DITP" edit_uri: edit/main/docs diff --git a/pubcode.yaml b/pubcode.yaml index fd3788f..6945407 100644 --- a/pubcode.yaml +++ b/pubcode.yaml @@ -4,7 +4,7 @@ data_management_roles: product_information: ministry: CITZ product_acronym: DT - product_description: Technical and non-technical documentation for Digital Trust and Verifiable Credentials + product_description: Technical and non-technical documentation for the Common Hosted Digital Credential Service product_name: product_technology_information: hosting_platforms: Private-Cloud-Openshift