From 20c5efa2b18ef265e34ce9a9a6a31bc5923182c6 Mon Sep 17 00:00:00 2001 From: Markus Sabadello Date: Thu, 2 Jan 2020 15:24:45 +0100 Subject: [PATCH] Update various documentation files. Signed-off-by: Markus Sabadello --- README.md | 6 +++++- docs/branching-strategy.md | 2 ++ docs/continuous-integration-and-delivery.md | 2 ++ docs/creating-releases.md | 2 ++ docs/design-goals.md | 2 +- docs/dev-system.md | 2 +- docs/driver-development.md | 2 ++ docs/troubleshooting.md | 2 +- drivers/btcr/README.md | 2 +- drivers/ccp/README.md | 2 +- drivers/dns/README.md | 2 +- drivers/dom/README.md | 2 +- drivers/erc725/README.md | 2 +- drivers/sov/README.md | 2 +- drivers/stack/README.md | 2 +- drivers/work/README.md | 2 +- resolver/java/README.md | 4 +--- 17 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 61601108a..a646e4540 100644 --- a/README.md +++ b/README.md @@ -66,8 +66,12 @@ Are you developing a DID method and Universal Resolver driver? Click [Driver Dev ## More Information - * [Design Goals](/docs/design-goals.md) * [Driver Development](/docs/driver-development.md) + * [Continuous Integration and Delivery](/docs/continuous-integration-and-delivery.md) + * [Development System](/docs/dev-system.md) + * [Creating Releases](/docs/creating-releases.md) + * [Branching Strategy](/docs/branching-strategy.md) + * [Design Goals](/docs/design-goals.md) * [Troubleshooting](/docs/troubleshooting.md) * [Java Components](/resolver/java) diff --git a/docs/branching-strategy.md b/docs/branching-strategy.md index 105d60d87..f32ca561a 100644 --- a/docs/branching-strategy.md +++ b/docs/branching-strategy.md @@ -1,3 +1,5 @@ +# Universal Resolver — Branching Strategy + The goals for our branching strategy are: * The master-branch should be deployable at any time. This implies a stable build and the assurance that the core-functionality is provided at any time when cloning the master. * The master-branch should stay active. As collaboratively working with multiple developers, we encourage merging the code as frequently as possible. This will potentially disclose issues at an early stage and facilitate the repair. Furthermore, it makes clear that the master-branch is the preferred choice that newcomers want to clone. diff --git a/docs/continuous-integration-and-delivery.md b/docs/continuous-integration-and-delivery.md index c025b6d4a..880237443 100644 --- a/docs/continuous-integration-and-delivery.md +++ b/docs/continuous-integration-and-delivery.md @@ -1,3 +1,5 @@ +# Universal Resolver — Continuous Integration and Delivery + This section describes the building-blocks and ideas of the implemented CI/CD pipeline. In case of issues or requests in the scope of CI/CD, please directly consult the maintainers of the repository. ## Intro diff --git a/docs/creating-releases.md b/docs/creating-releases.md index a2a8a97f6..2b6849e13 100644 --- a/docs/creating-releases.md +++ b/docs/creating-releases.md @@ -1,3 +1,5 @@ +# Universal Resolver — Creating Releases + This guide explains the release process of the universal resolver. ## Version Number diff --git a/docs/design-goals.md b/docs/design-goals.md index ffb5e256d..0d2a129ff 100644 --- a/docs/design-goals.md +++ b/docs/design-goals.md @@ -1,4 +1,4 @@ -# Universal Resolver - Design Goals +# Universal Resolver — Design Goals The main design objectives of the UR are: diff --git a/docs/dev-system.md b/docs/dev-system.md index b5a347c31..382f78151 100644 --- a/docs/dev-system.md +++ b/docs/dev-system.md @@ -1,4 +1,4 @@ -# Development System of the Universal Resolver +# Universal Resolver — Development System The dev-system or the sandbox installation, which runs the latest code-base of the Universal Resolver project, is hosted at: diff --git a/docs/driver-development.md b/docs/driver-development.md index 8aea1a58f..55ac2e2df 100644 --- a/docs/driver-development.md +++ b/docs/driver-development.md @@ -1,3 +1,5 @@ +# Universal Resolver — Driver Development + ## Introduction The Universal Resolver's main function is wrapping an API around a number of colocated Docker containers running DID-method-specific resolvers. As such, the resolver supports all open-source drivers which have been contributed to-date. The Universal Resolver is meant to support additional DID methods as they are developed by members of various communities. The contribution for a new DID method consists of a Docker image which exposes an HTTP GET interface for resolving DIDs. Although drivers can be implemented in whichever language and architecture the contributor prefers, drivers that are contributed will share a few common characteristics. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index e81889291..5042f05f2 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,4 +1,4 @@ -## Troubleshooting +# Universal Resolver — Troubleshooting If docker-compose complains about wrong versions then you probably have a too old docker-compose version. diff --git a/drivers/btcr/README.md b/drivers/btcr/README.md index 1fe3c73bd..1cb670eed 100644 --- a/drivers/btcr/README.md +++ b/drivers/btcr/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [BTCR DID Method 0.1](https://w3c-ccg.github.io/didm-btcr) ## Example DIDs diff --git a/drivers/ccp/README.md b/drivers/ccp/README.md index f7426b3eb..b533f2f0b 100644 --- a/drivers/ccp/README.md +++ b/drivers/ccp/README.md @@ -11,7 +11,7 @@ More info: ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [Baidu Cloud DID Method Specification](https://did.baidu.com/did-spec/) ## Example DIDs diff --git a/drivers/dns/README.md b/drivers/dns/README.md index 98baa4672..3ab1d5355 100644 --- a/drivers/dns/README.md +++ b/drivers/dns/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [The Decentralized Identifier (DID) in the DNS](https://datatracker.ietf.org/doc/draft-mayrhofer-did-dns/) ## Example Identifiers diff --git a/drivers/dom/README.md b/drivers/dom/README.md index 307158876..64edd29b1 100644 --- a/drivers/dom/README.md +++ b/drivers/dom/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * Dominode DID Method Specification (missing) ## Example DIDs diff --git a/drivers/erc725/README.md b/drivers/erc725/README.md index 06d412cee..291c9fead 100644 --- a/drivers/erc725/README.md +++ b/drivers/erc725/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [ERC725 DID Method Specification](https://github.com/WebOfTrustInfo/rebooting-the-web-of-trust-spring2018/blob/master/topics-and-advance-readings/DID-Method-erc725.md) ## Example DIDs diff --git a/drivers/sov/README.md b/drivers/sov/README.md index f50a074ea..febbda92e 100644 --- a/drivers/sov/README.md +++ b/drivers/sov/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [Sovrin DID Method Specification](https://sovrin-foundation.github.io/sovrin/spec/did-method-spec-template.html) ## Example DIDs diff --git a/drivers/stack/README.md b/drivers/stack/README.md index dd1f3fd37..d4332f176 100644 --- a/drivers/stack/README.md +++ b/drivers/stack/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * Blockstack DID Method Specification (missing) ## Example DIDs diff --git a/drivers/work/README.md b/drivers/work/README.md index 8f6559816..9b9a49f7b 100644 --- a/drivers/work/README.md +++ b/drivers/work/README.md @@ -6,7 +6,7 @@ This is a [Universal Resolver](https://github.com/decentralized-identity/univers ## Specifications -* [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) +* [Decentralized Identifiers](https://w3c.github.io/did-core/) * [work DID Method Specification](https://workday.github.io/work-did-method-spec/) ## Example DIDs diff --git a/resolver/java/README.md b/resolver/java/README.md index 1eac7f6b3..1c6173fc5 100644 --- a/resolver/java/README.md +++ b/resolver/java/README.md @@ -1,6 +1,4 @@ -![DIF Logo](https://raw.githubusercontent.com/decentralized-identity/decentralized-identity.github.io/master/images/logo-small.png) - -# Universal Resolver - Java Implementation +# Universal Resolver — Java Components This is a Java implementation of a Universal Resolver. See [universal-resolver](https://github.com/decentralized-identity/universal-resolver/) for a general introduction to Universal Resolvers and drivers.