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

Creating new folder and file structure and TOC #5

Merged
merged 2 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api_testing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "API endpoint testing",
"position": 5,
"link": {
"type": "generated-index",
"description": "API endpoint testing with DTT"
}
}
9 changes: 9 additions & 0 deletions docs/api_testing/api_testing_intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Introduction to API endpoint testing with DTT {#introduction-to-api-endpoint-testing-with-dtt}

**_TODO_**: Focus on core VC capabilities: issue, verify, revoke. The objective is to help understand the interop capabilities of a specific endpoint by analyzing the interactions between this test suite and that endpoint.


Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Developer Guide",
"position": 3,
"position": 6,
"link": {
"type": "generated-index",
"description": "DTT API Developer Guide (TODO)."
"description": "DTT API Developer Guide."
}
}
File renamed without changes.
File renamed without changes.
8 changes: 8 additions & 0 deletions docs/dtt_overview/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "DTLab's Digital Trust Testbench (DTT) Overview",
"position": 1,
"link": {
"type": "generated-index",
"description": "DTLab's Digital Trust Testbench (DTT) Overview"
}
}
7 changes: 7 additions & 0 deletions docs/dtt_overview/dtt_how_can_i_contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# How can I contribute to DTT?

[Contact us!](mailto:[email protected])
11 changes: 3 additions & 8 deletions docs/index.md → docs/dtt_overview/dtt_what_is_dtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,10 @@ slug: /
sidebar_position: 1
---

# DTLab's Digital Trust Testbench (DTT)
# What is DTT?

![DTT Workshop](./images/dtt-workshop.png)
![DTT Workshop](../images/dtt-workshop.png)

## Introduction
**Digital Trust Test Bench (DTT)** is a quality assurance tool for digital credential solutions, allowing governments and organizations to put digital credentials to the test to make sure they work with other platforms.


## Summary of Documentation
* [User guide](userguide/ug_intro.md)
* [Developer guide](developerguide/dg_intro.md)

DTT is not: a certification or compliance tool.
9 changes: 9 additions & 0 deletions docs/dtt_overview/dtt_who_develops_and_maintain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 2
---

# Who develops and maintains DTT?

**_TO-DO_**: reuse existing content!

Note: standards are evolving, those test suites are designed to quickly adapt to those needs.
8 changes: 8 additions & 0 deletions docs/mdl_testing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "mDL 18013-5 testing",
"position": 4,
"link": {
"type": "generated-index",
"description": "mDL 18013-5 testing with DTT"
}
}
9 changes: 9 additions & 0 deletions docs/mdl_testing/mdl_testing_intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Introduction to API endpoint testing with DTT {#introduction-to-api-endpoint-testing-with-dtt}

**_TODO_**: Focus on core VC capabilities: issue, verify, revoke. The objective is to help understand the interop capabilities of a specific endpoint by analyzing the interactions between this test suite and that endpoint.


8 changes: 0 additions & 8 deletions docs/userguide/_category_.json

This file was deleted.

3 changes: 0 additions & 3 deletions docs/userguide/ug_data_model.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/userguide/ug_getting_started.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/userguide/ug_intro.md

This file was deleted.

8 changes: 8 additions & 0 deletions docs/w3c_did/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "W3C DID testing",
"position": 2,
"link": {
"type": "generated-index",
"description": "Testing W3C Decentralized Idenfitiers (DIDs) with DTT."
}
}
11 changes: 11 additions & 0 deletions docs/w3c_did/did_about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 6
---

# About the W3C DID test suite

**_TO-DO_**: Currently powered by goddidy - learn more here: XXX

**_TO-DO_**: Additional resources:
* Learn more about DIDs here: XXX
* Get involved here: XXX
7 changes: 7 additions & 0 deletions docs/w3c_did/did_how_to_use.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# How to use this test suite

**_TO-DO_**: How to access / configure this test suite: availability test/prod, user account, etc.
11 changes: 11 additions & 0 deletions docs/w3c_did/did_input.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 4
---

# The “thing” to test

Enter the URL representing a DID, click on **Resolve DID**.

**_TO-DO_**: Need examples to try it out? Check out links to DIF universal resolver samples and godiddy samples? We should probably provide our own examples, starting with what we use internally for unit testing

**_FUTURE_**: options/parameters.
13 changes: 13 additions & 0 deletions docs/w3c_did/did_intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 1
---

# Introduction to W3C DID

## What are DIDs? {#what-are-dids}

**_TO-DO_**: reuse someone else’s content here!

## What is their role / how are they being used? {#what-is-their-role-how-are-they-being-used}

**_TO-DO_**: reuse someone else’s content here!
21 changes: 21 additions & 0 deletions docs/w3c_did/did_results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 5
---

# Test results

## How to inspect and understand your test results {#how-to-inspect-and-understand-your-test-results}

**_TO-DO_**: plain English overview of results, maybe in the form of a simple checklist?


## Common errors and their meaning {#common-errors-and-their-meaning}

| Error code | Description | What it might mean |
| ---------- | ----------- | ------------------ |
| xxx | _DID method not supported_ | DTT is not currently configured to have access to a driver for this DID method, or a driver hasn’t been implemented yet. |
| xxx | _Another error_ | This is what this one might mean |

## How to save and share your test results {#how-to-save-and-share-your-test-results}

**_FUTURE_**: intro to Allure report framework
31 changes: 31 additions & 0 deletions docs/w3c_did/did_specs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
sidebar_position: 2
---

# Standards and specifications for DID methods

## Understanding the Decentralized Identifier ecosystem {#understanding-the-decentralized-identifier-ecosystem}

See [universal-resolver/docs/driver-development.md at main](https://github.com/decentralized-identity/universal-resolver/blob/main/docs/driver-development.md#driver-rules)

[DID Specification Registries](https://www.w3.org/TR/did-spec-registries/)



## W3C DID core specification {#w3c-did-core-specification}

[Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/)


## Method-specific specifications and best practices {#method-specific-specifications-and-best-practices}

**_TO-DO_**: We need to explain the role of those specs in relation to the CORE spec, which we can get from the primer sections of those specs hopefully, but also what exactly we are testing for here (which may require explaining that it depends on what validation the driver for this specific method has implemented)

| DID method | Specification | Status |
| ---------- | ------------- | ------ |
| did:indy | https://github.com/hyperledger/indy-did-method | |
| did:key | https://w3c-ccg.github.io/did-method-key | The did:key Method v0.7 |
| did:peer | https://identity.foundation/peer-did-method-spec | Peer DID Method Specification |
| did:tdw | https://bcgov.github.io/trustdidweb | Trust DID Web - The did:tdw DID Method |
| did:web | https://w3c-ccg.github.io/did-method-web | Unofficial draft authored by the [W3C Credentials Community Group](https://www.w3.org/community/credentials/). |
| did:x509 | https://github.com/microsoft/did-x509 | DRAFT: did:x509 Decentralized Identifier Method Specification |
8 changes: 8 additions & 0 deletions docs/w3c_vcdm/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "W3C Verifiable Credential testing",
"position": 3,
"link": {
"type": "generated-index",
"description": "Testing W3C Verifiable Credentials (VCs) with DTT."
}
}
11 changes: 11 additions & 0 deletions docs/w3c_vcdm/vcdm_about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 6
---

# About the W3C VCDM test suite

**_TODO_**: explain where this version of the test suite comes from, where the repo is, and how it’s configured

**_TODO_**: Additional resources
* Learn more about the W3C Verifiable Credential Data Model here: XXX
* Get involved here: XXX
11 changes: 11 additions & 0 deletions docs/w3c_vcdm/vcdm_how_to_use.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---

# How to use this test suite

The purpose of this test suite is to test an issued Verifiable Credential for conformance with the VC data model 1.1 specification.

[https://dtt.dtlab-labcn.app/test-suites/credentials/w3c](https://dtt.dtlab-labcn.app/test-suites/credentials/w3c)

**_TODO_**: How to access / configure this test suite: availability test/prod, user account, etc.
12 changes: 12 additions & 0 deletions docs/w3c_vcdm/vcdm_input.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 4
---

# The “thing” to test

Paste a JSON-LD Credential containing a VC and click on **Submit**.

**_TODO_**: Need examples to try it out? Check out (insert links to DIF universal resolver samples and godiddy samples), We should probably provide our own examples, starting with what we use internally for unit testing)

**_FUTURE_**: options/parameters.

7 changes: 7 additions & 0 deletions docs/w3c_vcdm/vcdm_intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Introduction to the W3C Verifiable Credential Data Model

The W3C Verifiable Credential Data Model provides a standard way to express credentials on the Web in a way that is cryptographically secure, privacy respecting, and machine-verifiable.
18 changes: 18 additions & 0 deletions docs/w3c_vcdm/vcdm_results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 5
---

# Test results

## How to inspect and understand your test results {#how-to-inspect-and-understand-your-test-results}

**_TO-DO_**: plain English overview of results, maybe in the form of a simple checklist?


## Common errors and their meaning {#common-errors-and-their-meaning}

**_TODO_**: this section may not be as relevant for VCDM testing as it is for DID testing?

## How to save and share your test results {#how-to-save-and-share-your-test-results}

**_FUTURE_**: intro to Allure report framework
9 changes: 9 additions & 0 deletions docs/w3c_vcdm/vcdm_specs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 2
---

# Standards and specifications for the W3C Verifiable Credential Data Model

**_TODO_**: write brief intro with explanation for current versions and status

[Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)