From 08fb6e689e5e35483ed75019e389dad82325022e Mon Sep 17 00:00:00 2001 From: ndr_brt Date: Fri, 20 Sep 2024 10:36:12 +0200 Subject: [PATCH] docs: update documentation --- CONTRIBUTING.md | 5 -- README.md | 19 ++++++- docs/developer/README.md | 1 - docs/legal/generateThirdPartyReport.sh | 78 -------------------------- 4 files changed, 17 insertions(+), 86 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 docs/developer/README.md delete mode 100755 docs/legal/generateThirdPartyReport.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index dfd6000..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing to the Project - -Thank you for your interest in contributing to this project. Please refer to -the [contributing guidelines of the Eclipse Dataspace Connector project](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/1daf73d2fdaf1c1622c448fbaae4ac01af7df01c/CONTRIBUTING.md) -. \ No newline at end of file diff --git a/README.md b/README.md index 6f3c77d..f5828f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,22 @@ -# Runtime Metamodel +# EDC Runtime Metamodel + +[![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/runtime-metamodel?logo=apache-maven&style=flat-square&label=latest%20version)](https://search.maven.org/artifact/org.eclipse.edc/runtime-metamodel) +[![license](https://img.shields.io/github/license/eclipse-edc/Runtime-Metamodel?style=flat-square&logo=apache)](https://www.apache.org/licenses/LICENSE-2.0) +
+[![build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Runtime-Metamodel/verify.yaml?branch=main&logo=GitHub&style=flat-square&label=ci)](https://github.com/eclipse-edc/Runtime-Metamodel/actions/workflows/verify.yaml?query=branch%3Amain) +[![snapshot build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Runtime-Metamodel/trigger_snapshot.yml?branch=main&logo=GitHub&style=flat-square&label=snapshot-build)](https://github.com/eclipse-edc/Runtime-Metamodel/actions/workflows/trigger_snapshot.yml) +[![nightly build](https://img.shields.io/github/actions/workflow/status/eclipse-edc/Release/nightly.yaml?branch=main&logo=GitHub&style=flat-square&label=nightly-build)](https://github.com/eclipse-edc/Release/actions/workflows/nightly.yaml) + +--- This repository contains the runtime metamodel classes and annotations that describe the EDC module model. +### Documentation + +Base documentation can be found on the [documentation website](https://eclipse-edc.github.io). + ## Contributing -See [how to contribute](https://github.com/eclipse-edc/.github/blob/main/CONTRIBUTING.md). +See [how to contribute](https://github.com/eclipse-edc/eclipse-edc.github.io/blob/main/CONTRIBUTING.md). diff --git a/docs/developer/README.md b/docs/developer/README.md deleted file mode 100644 index 4796167..0000000 --- a/docs/developer/README.md +++ /dev/null @@ -1 +0,0 @@ -# Developer Documentation diff --git a/docs/legal/generateThirdPartyReport.sh b/docs/legal/generateThirdPartyReport.sh deleted file mode 100755 index a67f58e..0000000 --- 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-.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