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: add docsify #1012

Merged
merged 5 commits into from
May 12, 2022
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
Empty file added docs/.nojekyll
Empty file.
2 changes: 1 addition & 1 deletion docs/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ TBD
TBD

### How write custom extension
TBD
TBD
10 changes: 1 addition & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
**Please note**

### Work in progress

All content reflects the current state of discussion, not final decisions.

---

# Eclipse Dataspace Connector

TBD
**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions.

## Overview

Expand Down
16 changes: 16 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
![logo](_media/icon.png)

# Eclipse Dataspace Connector

[comment]: <> (<small>1.0.0</small>)

> A scalable cloud data connector.

- Modular and extensible
- Asynchronous and highly available
- Secure and sovereign data transfer

[GitHub](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector)
[Getting Started](README.md)

![color](#f0f0f0)
Binary file added docs/_media/favicon.ico
Binary file not shown.
Binary file added docs/_media/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* [Community E-Mail](https://accounts.eclipse.org/mailing-list/dataspaceconnector-community)
* [Developer E-Mail](https://accounts.eclipse.org/mailing-list/dataspaceconnector-dev)
* [Website](https://projects.eclipse.org/projects/technology.dataspaceconnector)
* [YouTube](https://www.youtube.com/channel/UCYmjEHtMSzycheBB4AeITHg)
49 changes: 49 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[comment]: <> (Each folder in the /docs directory contains files for a section. The README.md is the
landing page of this section. Other subsections are placed below and can be linked separately. Feel
free to add sections and subsections to this sidebar.)

- [Home](README.md)
- [Hands-on](samples.md)

- Architecture
- [Overview](architecture/README.md)
- [Configuration](architecture/configuration.md)
- [Contracts](architecture/contracts.md)
- [Data Flow](diagrams/data-flow/README.md)
- [Domain Model](domain-model.md)
- [Policies](Policies.md)
- [Principles](architecture-principles.md)
- [Terminology](Terminology.md)

- IDS
- [Overview](ids/README.md)
- [Architectural Alignment](ids/architectural-alignment.md)
- [Key Components](ids/key-components.md)

- Developer
- [Command Queue](command-queue.md)
- [Dependency Resolution](developer/dependency_resolution.md)
- [DPF Selector](developer/dpf_selector.md)
- [DPF Transfer](developer/dpf_transfer.md)
- [Metrics](metrics.md)
- [Release Approach](developer/releases.md)
- [Writing Tests](testing.md)

- Decision Records
- [2022-02-03 Integration Testing](developer/decision-records/2022-02-03-integration-testing/README.md)
- [2022-02-07 Micrometer Metrics](developer/decision-records/2022-02-07-micrometer-metrics/README.md)
- [2022-02-07 Tracing](developer/decision-records/2022-02-07-tracing/README.md)
- [2022-02-10 Code Coverage](developer/decision-records/2022-02-10-code-coverage/README.md)
- [Jacoco](developer/decision-records/2022-02-10-code-coverage/jacoco.md)
- [Jacoco with Codacy](developer/decision-records/2022-02-10-code-coverage/codacy.md)
- [Jacoco with Codecov](developer/decision-records/2022-02-10-code-coverage/codecov.md)
- [Jacoco with GitHub Actions](developer/decision-records/2022-02-10-code-coverage/jacoco_github_action.md)
- [Jacoco with Sonarqube](developer/decision-records/2022-02-10-code-coverage/sonarqube.md)
- [2022-02-11 CodeQL](developer/decision-records/2022-02-11-codeql/README.md)
- [2022-02-14 Helm Chart](developer/decision-records/2022-02-14-helm-chart/README.md)
- [2022-03-02 Performance Tests](developer/decision-records/2022-03-02-performance-tests/README.md)
- [2022-03-11 Story Issues](developer/decision-records/2022-03-11-story-issues/README.md)
- [2022-03-15 Policy Scopes](developer/decision-records/2022-03-15-policy-scopes/README.md)
- [2022-03-15 Swagger Annotations](developer/decision-records/2022-03-15-swagger-annotations/README.md)
- [2022-03-30 CosmosDB Lease Mechanism](developer/decision-records/2022-03-30-cosmosdb-lease-mechanism/README.md)
- [2022-04-21 DPF Blob Data Transfer](developer/decision-records/2022-04-21-dpf-blob-data-transfer/README.md)
10 changes: 2 additions & 8 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
**Please note**

### Work in progress

All content reflects the current state of discussion, not final decisions.

---

# Architecture

**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions.

## Configuration

Each EDC extension may use its own configuration settings and should explain them in their corresponding README.md.
Expand Down
12 changes: 3 additions & 9 deletions docs/architecture/configuration.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
**Please note**

### Work in progress

All content reflects the current state of discussion, not final decisions.

---

# Configuration

**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions.

It is possible to configure the Eclipse Dataspace Connector. All configuration are retrieved by their key from an
extension, that implements the Configuration Extension interface.

Expand Down Expand Up @@ -50,4 +44,4 @@ The integration of each configuration extension may vary. Please have a look at

The following extensions implement the ConfigurationExtension interface.

- [File System Configuration](../../extensions/filesystem/configuration-fs/README.md)
- [File System Configuration](../../extensions/filesystem/configuration-fs/README.md)
12 changes: 3 additions & 9 deletions docs/architecture/contracts.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
**Please note**

### Work in progress

All content reflects the current state of discussion, not final decisions.

---

# Contracts

**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions.

## Offering

The EDC connector is able to provide contract offers. This feature requires four different types of extensions:
Expand Down Expand Up @@ -41,4 +35,4 @@ The EDC connector is able to provide contract offers. This feature requires four

## Negotiation

TBD
TBD
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Code coverage coming from JaCoCo reports can be added to a PR using [Github Acti
```
The above workflow will send a comment to the PR showing the code coverage of the files modified in the PR and the overall project code coverage.

![Code Coverage with JaCoCo and Github Action](code-coverage-jacoco-gitbhub-actions.png)
![Code Coverage with JaCoCo and Github Action](code-coverage-jacoco-gitbhub-actions.png)
12 changes: 3 additions & 9 deletions docs/ids/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
**Please note**

### Work in progress

All content reflects the current state of discussion, not final decisions.

---

# IDS

**Please note**: Work in progress. All content reflects the current state of discussion, not final decisions.

## Specification

### Compliance Issues
Expand All @@ -22,4 +16,4 @@ will never fulfil. The self-description is only returned on the corresponding RE

#### 2. Only one Information Model version supported at a time

The EDC connector will not be able to support more than one IDS Information model per running instance.
The EDC connector will not be able to support more than one IDS Information model per running instance.
72 changes: 72 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<title>Eclipse Dataspace Connector</title>
<link rel="icon" href="_media/favicon.ico" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="A scalable cloud data connector." />
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" title="vue"/>
<style>
nav.app-nav li ul {
min-width: 100px;
}

.content {
overflow: auto;
}
</style>
</head>

<body>
<div id="app">Loading...</div>
<script>
window.$docsify = {
alias: {
'.*?/changelog':
'https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/CHANGELOG.md',
'/.*/_sidebar.md': '/_sidebar.md',
},
auto2top: true,
coverpage: true,
el: '#app',
executeScript: true,
loadSidebar: true,
loadNavbar: true,
name: 'Dataspace Connector',
nativeEmoji: true,
notFoundPage: true,
onlyCover: true,
relativePath: false,
repo: 'eclipse-dataspaceconnector/DataSpaceConnector',
search: {
noData: {
'/': 'No results!',
},
paths: 'auto',
placeholder: {
'/': 'Search',
},
depth: 6,
},
subMaxLevel: 1,
themeColor: '#8BC440', // eclipse incubation orange: #f78e2c // edc blue: #27A9DE
timeUpdater: {
text: "_Last updated on {docsify-updated}_",
formatUpdated: "{YYYY}-{MM}-{DD}",
whereToPlace: "top"
},
topMargin: 90,
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-updated/src/time-updater.min.js"></script>
</body>
</html>
13 changes: 13 additions & 0 deletions docs/samples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Hands-on

If you want to become familiar with the EDC and its functionalities, please take a look at our samples.
For each, a detailed documentation is prepared that guides you step by step and explains major topics.

- [1 Run the Connector](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/01-basic-connector/README.md)
- [2 Write a First Extension](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/02-health-endpoint/README.md)
- [3 Apply Custom Configurations](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/03-configuration/README.md)
- [4 Perform a Contract Negotiation](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.0-file-transfer/README.md)
- [4.1 Implement a Simple Transfer Listener](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.1-file-transfer-listener/README.md)
- [4.2 Modify a Transfer Process](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.2-modify-transferprocess/README.md)
- [4.3 Work with Open Telemetry](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/04.3-open-telemetry/README.md)
- [5 Run a Cloud Deployment](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/samples/05-file-transfer-cloud/README.md)