From 93242b12223987dbab77ce6dc61f2a3c0ac04cc8 Mon Sep 17 00:00:00 2001 From: ndr_brt Date: Fri, 20 Sep 2024 13:28:48 +0200 Subject: [PATCH] docs: cleanup README --- README.md | 19 ++++-- docs/developer/decision-records/README.md | 3 - docs/legal/generateThirdPartyReport.sh | 78 ----------------------- 3 files changed, 13 insertions(+), 87 deletions(-) delete mode 100644 docs/developer/decision-records/README.md delete mode 100644 docs/legal/generateThirdPartyReport.sh diff --git a/README.md b/README.md index 92e23a62..b8cf5562 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ -# Technology Aws +# EDC Technology Aws -This repository contains AWS-specific implementations for several SPIs of the [Eclipse Dataspace Components Connector](https://github.com/eclipse-edc/Connector): +[![documentation](https://img.shields.io/badge/documentation-8A2BE2?style=flat-square)](https://eclipse-edc.github.io) +[![discord](https://img.shields.io/badge/discord-chat-brightgreen.svg?style=flat-square&logo=discord)](https://discord.gg/n4sD9qtjMQ) +[![latest version](https://img.shields.io/maven-central/v/org.eclipse.edc.aws/aws-spi?logo=apache-maven&style=flat-square&label=latest%20version)](https://search.maven.org/artifact/org.eclipse.edc.aws/aws-spi) +[![license](https://img.shields.io/github/license/eclipse-edc/Technology-Aws?style=flat-square&logo=apache)](https://www.apache.org/licenses/LICENSE-2.0) +
+[![build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Technology-Aws/verify.yaml?branch=main&logo=GitHub&style=flat-square&label=ci)](https://github.com/eclipse-edc/Technology-Aws/actions/workflows/verify.yaml?query=branch%3Amain) +[![snapshot build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Technology-Aws/trigger_snapshot.yml?branch=main&logo=GitHub&style=flat-square&label=snapshot-build)](https://github.com/eclipse-edc/Technology-Aws/actions/workflows/trigger_snapshot.yml) +[![nightly build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Technology-Aws/nightly.yaml?branch=main&logo=GitHub&style=flat-square&label=nightly-build)](https://github.com/eclipse-edc/Technology-Aws/actions/workflows/nightly.yaml) +--- +This repository contains AWS-specific implementations for several SPIs of the [Eclipse Dataspace Components Connector](https://github.com/eclipse-edc/Connector): ## Documentation -Developer documentation can be found under [docs/developer](docs/developer/), where the main concepts and decisions are -captured as [decision records](docs/developer/decision-records/). +Base documentation can be found on the [documentation website](https://eclipse-edc.github.io). ## Contributing -See [how to contribute](https://github.com/eclipse-edc/docs/blob/main/CONTRIBUTING.md) for -details. \ No newline at end of file +See [how to contribute](https://github.com/eclipse-edc/eclipse-edc.github.io/blob/main/CONTRIBUTING.md). diff --git a/docs/developer/decision-records/README.md b/docs/developer/decision-records/README.md deleted file mode 100644 index 2cf4866e..00000000 --- a/docs/developer/decision-records/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Decision Records - -This is the folder where all decision records are aggregated. \ No newline at end of file diff --git a/docs/legal/generateThirdPartyReport.sh b/docs/legal/generateThirdPartyReport.sh deleted file mode 100644 index 1e0ee61f..00000000 --- a/docs/legal/generateThirdPartyReport.sh +++ /dev/null @@ -1,78 +0,0 @@ -#!/bin/bash - -# Usage: -# generateThirdPartyReport.sh /path/inputFilename -# -# Prerequisites: -# The Eclipse Dash Licenses tool was executed and resulted in an file (e.g., NOTICES) -# listing all dependencies of the project. -# To process the dependencies of a specific module, execute the following command: -# gradle dependencies | grep -Poh "(?<=\s)[\w\.-]+:[\w\.-]+:[^:\s]+" | sort | uniq | java -jar /path/org.eclipse.dash.licenses-0.0.1-SNAPSHOT.jar - -summary NOTICES -# -# Comments: -# Gradle doesn't support listing all dependencies of a multi-module project out of the box. -# The following custom task can be used to achieve this: -# subprojects { -# tasks.register("allDependencies"){} -# } -# - -input="$1" -output="./Third-Party-Content.md" - -touch "$output" -echo -n "" > "$output" -echo "## Third Party Content" >> "$output" - -while IFS= read -r line -do - #Results are separated by comma - IFS=', ' read -r -a row <<< "$line" - dependency="${row[0]}" - - #Dependencies which could not be resolved are marked as invalid - if [[ $dependency == maven/mavencentral/* ]]; - then - length=${#dependency} - mavenPath=${dependency:19:length} - - IFS='/ ' read -r -a hierarchy <<< "$mavenPath" - - groupId=${hierarchy[0]} - #Periods must be replaced with slashes to be used later in the context of an URL - groupIdUrl=${groupId//./$'/'} - artifactId=${hierarchy[1]} - version=${hierarchy[2]} - - path="$groupIdUrl/$artifactId/$version/$artifactId-$version.pom" - - #Example URL: https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/2.12.1/jackson-core-2.12.1.pom - targetUrl="https://repo1.maven.org/maven2/$path" - - pomFile=$(curl $targetUrl) - - projectName=$(xmllint --xpath "/*[local-name() = 'project']/*[local-name() = 'name']/text()" - <<< $pomFile) - projectUrl=$(xmllint --xpath "/*[local-name() = 'project']/*[local-name() = 'url']/text()" - <<< $pomFile) - scmUrl=$(xmllint --xpath "/*[local-name() = 'project']/*[local-name() = 'scm']/*[local-name() = 'connection']/text()" - <<< $pomFile) - - if [[ ! -z "$projectName" ]]; - then - echo "$projectName" >> "$output" - - if [[ ! -z "$projectUrl" ]]; - then - echo "* Project: $projectUrl" >> "$output" - fi - - if [[ ! -z "$scmUrl" ]]; - then - echo "* Source: $scmUrl" >> "$output" - fi - - echo "* Maven Artifact: $mavenPath" >> "$output" - echo "* License: ${row[1]}" >> "$output" - echo "" >> "$output" - fi - fi - -done < "$input" \ No newline at end of file