Skip to content

Commit

Permalink
Update all the remaining READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
berezovskyi committed Dec 18, 2020
1 parent e326974 commit 3f26fb8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 60 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,23 @@ See under [domains/README](domains/README.md).

See under [store/README](store/README.md).

### TRS Server

To use this library, follow the setup and development instructions under the [OSLC Developer Guide for TRS server setup](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/setup-an-oslc-provider-consumer-application.html#provide-trs-support). The instructions assume you have followed the overall instructions to setup an OSLC4J server/client, as defined on that page.

You can find more resources for developing OSLC applications with Lyo in general under the [OSLC Developer Guide](http://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo.html), and in particular [for TRS development](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo#trs-sdk).

See [trs/server/README](trs/server/README.md) for dev notes.

### TRS Client

See under [trs/client/README](trs/client/README.md).

### Validation

See under [validation/README](validation/README.md).


## Repositories

### Main project repositories
Expand Down
6 changes: 0 additions & 6 deletions trs/client/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# TRS Client

![CI](https://github.com/eclipse/lyo.trs-client/workflows/CI/badge.svg)
[![](https://img.shields.io/badge/javadoc-latest-blue.svg)](https://download.eclipse.org/lyo/docs/trs-client/latest/)
[![Discourse users](https://img.shields.io/discourse/users?color=28bd84&server=https%3A%2F%2Fforum.open-services.net%2F)](https://forum.open-services.net/)


## Motivation

The *TRS Client* utility uses the TRS interfaces of existing OSLC adapters in order to cache the data exposed by these OSLC adadapters in a preconfigured HTTP SPARQL enabled triplestore and to keep this data cache up to date with the data coming from the adapters. for more information please check the [OSLC TRS 2.0 draft spec][1]
Expand All @@ -25,7 +20,6 @@ The implementation of the following features is planned:
* Support of OAuth authentication
* Management of Server Rollback to an earlier state


## FAQ

**There is an error in `ModelCreationUtil.java`**
Expand Down
28 changes: 0 additions & 28 deletions trs/server/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# TRS Server library

![CI](https://github.com/eclipse/lyo.trs-server/workflows/CI/badge.svg)
[![](https://img.shields.io/badge/javadoc-2.4.0-blue.svg)](https://download.eclipse.org/lyo/docs/trs-server/2.4.0/overview-summary.html)
[![](https://img.shields.io/badge/javadoc-latest-blue.svg)](https://download.eclipse.org/lyo/docs/trs-server/latest/overview-summary.html)
[![Discourse users](https://img.shields.io/discourse/users?color=28bd84&server=https%3A%2F%2Fforum.open-services.net%2F)](https://forum.open-services.net/)

This repository contains the [Eclipse Lyo](https://projects.eclipse.org/projects/technology.lyo) *TRS Server* library.

The *TRS Server* library is a set of ready-to-use classes that provide the required REST services for TRS, with minimal effort.
Expand All @@ -14,29 +9,6 @@ These classes are however designed to be extended for a persistent solution.

For a thourough walkthough of TRS solutions, which among other things ensures persisting the TRS Logs, visit the [additional information on TRS](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo#trs-sdk).

## Introduction

The [Eclipse Lyo](https://projects.eclipse.org/projects/technology.lyo) project is focused on providing an SDK to enable adoption of [OSLC specifications](https://open-services.net/). OSLC (Open Services for Lifecycle Collaboration) is an open community dedicated to reducing barriers for lifecycle tool integration. The community authors specifications for exposing lifecycle artifacts through uniform (REST) interfaces and relying on Internet and Linked Data standards.

OSLC's scope started with Application Lifecycle Management (ALM) and is expanding to include integrations across Product Lifecycle Management (PLM) and IT Service Management (ISM/DevOps), Lyo is designed to be a companion to the continuing specification efforts of the OSLC community. Its main purpose is to expand adoption of OSLC specifications and to enable the Eclipse community to easily build OSLC compliant tools.

## Getting started

To use this library, follow the setup and development instructions under the [OSLC Developer Guide for TRS server setup](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/setup-an-oslc-provider-consumer-application.html#provide-trs-support). The instructions assume you have followed the overall instructions to setup an OSLC4J server/client, as defined on that page.

You can find more resources for developing OSLC applications with Lyo in general under the [OSLC Developer Guide](http://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo.html), and in particular [for TRS development](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/eclipse-lyo#trs-sdk).

You are also welcome to contact the development team via [lyo-dev mailing list](https://dev.eclipse.org/mailman/listinfo/lyo-dev)

## Contributing

See [contributing](https://github.com/eclipse/lyo#contributing) under the main [Eclipse Lyo](https://github.com/eclipse/lyo) repository.

## Building the project
(Unless you need to work from source code, you need not build this project. You are instead adviced to add the necessary Lyo dependecies as described under the [OSLC Developer Guide](https://oslc.github.io/developing-oslc-applications/eclipse_lyo/setup-an-oslc-provider-consumer-application.html).)

This project uses Maven as the build system for all Java projects except those which are Eclipse Plugin project. The latter projects contain all the Eclipse project files under Git for import and building using the *Import > Existing Projects into Workspace*. All other projects should be imported using the *Import > Existing Maven Projects* menu.

## Internal implementation

The TRS interface consists mainly of two classes:
Expand Down
31 changes: 5 additions & 26 deletions validation/README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,24 @@
# Lyo Validation library

[![CI](https://github.com/eclipse/lyo.validation/workflows/CI/badge.svg?branch=master)](https://github.com/eclipse/lyo.validation/actions?query=workflow%3ACI)
[![](https://img.shields.io/badge/javadoc-latest-blue.svg)](https://download.eclipse.org/lyo/docs/validation/latest)
[![Discourse users](https://img.shields.io/discourse/users?color=28bd84&server=https%3A%2F%2Fforum.open-services.net%2F)](https://forum.open-services.net/)

---

The library validates RDF resources against constraints defined either as [SHACL](https://www.w3.org/TR/shacl/) or [OSLC Resource Shapes](http://docs.oasis-open.org/oslc-core/oslc-core/v3.0/cs01/part6-resource-shape/oslc-core-v3.0-cs01-part6-resource-shape.html).

## Getting started

Add the following repository to your POM file:

```xml
<repositories>
<repository>
<id>lyo-releases</id>
<name>Eclipse Lyo Releases</name>
<url>https://repo.eclipse.org/content/repositories/lyo-releases/</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
```

Now add a dependency for the library:
Add a dependency for the library:

```xml
<dependency>
<groupId>org.eclipse.lyo</groupId>
<artifactId>lyo-validation</artifactId>
<version>2.3.0</version>
<version>${version.lyo}</version>
</dependency>
```

Start by reading the library's main interface class [`Validator`](http://download.eclipse.org/lyo/docs/validation/2.3.0/org/eclipse/lyo/validation/Validator.html) on Javadoc.
Start by reading the library's main interface class [`Validator`](https://download.eclipse.org/lyo/docs/all/latest/apidocs/org/eclipse/lyo/validation/Validator.html) on Javadoc.

You can also review the library's [unit test cases](https://github.com/eclipse/lyo-validation/tree/master/src/test/java/org/eclipse/lyo/validation) that shows how to use this interface.
You can also review the library's [unit test cases](src/test/java/org/eclipse/lyo/validation) that shows how to use this interface.

Finally, you can review the [sample application](https://github.com/eclipse/lyo-validation/blob/master/src/test/java/org/eclipse/lyo/validation/ValidationExample.java), which shows 3 validation examples, where:
Finally, you can review the [sample application](src/test/java/org/eclipse/lyo/validation/ValidationExample.java), which shows 3 validation examples, where:

* an RDF resource (jena model) is validated against a SHACL shape (another jena model).
* An java object (representing an RDF resource) is validated against SHACL annotations defined on its Java class.
Expand Down

0 comments on commit 3f26fb8

Please sign in to comment.