feat: add docsify framework

eclipse-edc · juliapampus · May 12, 2022 · Mar 30, 2022 · Mar 30, 2022 · May 11, 2022
commit 0a79b1511a813f9e4d8ea946be39dd454665fdc2
@@ -1,6 +1,6 @@
 **Please note**
 
-### Work in progress
+### Work in progress <!-- {docsify-ignore-all} -->
 
 All content reflects the current state of discussion, not final decisions.
 

@@ -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)
@@ -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)
@@ -0,0 +1,45 @@
+[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)
+  - [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)
+  - [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)
@@ -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)
@@ -0,0 +1,67 @@
+<!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: '#f78e2c',
+        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>
+  </body>
+</html>
@@ -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)