Skip to content

Commit

Permalink
Merge pull request #338 from eclipse-tractusx/docs/add-oss-info-to-de…
Browse files Browse the repository at this point in the history
…veloper-hub

doc: move updated TRG 7.0x for OSS doc out of drafts
  • Loading branch information
SebastianBezold authored Aug 17, 2023
2 parents cbb55a9 + dcf2a41 commit b488b63
Show file tree
Hide file tree
Showing 10 changed files with 139 additions and 181 deletions.
115 changes: 0 additions & 115 deletions docs/release/trg-0/trg-7-07.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/release/trg-7/trg-7-00.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: TRG 7.00 - Recurring activities for each PR
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | Moved from OSS Development |
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
| Status | Created | Post-History |
|--------|-------------|--------------------------------------|
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
| | 13-Apr-2023 | Moved from OSS Development |

## Why

Expand Down
12 changes: 6 additions & 6 deletions docs/release/trg-7/trg-7-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: TRG 7.01 - Legal Documentation
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | Moved from OSS Development |
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
| Status | Created | Post-History |
|--------|-------------|--------------------------------------|
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
| Active | 13-Apr-2023 | Moved from OSS Development |

## Why

Expand Down Expand Up @@ -67,7 +67,7 @@ If different technologies / package managers (e.g. npm and maven) are used you a

### SECURITY FILE

- The security file should at least contain information, where/how to report a vulneriability issue
- The security file should at least contain information, where/how to report a vulnerability issue
- Add this [link](https://www.eclipse.org/security/)
- [Example](https://github.com/eclipse-tractusx/app-dashboard/blob/main/SECURITY.md)

Expand Down Expand Up @@ -97,4 +97,4 @@ and here in [md format](https://raw.githubusercontent.com/eclipse/.github/master
## Existing checks for the legal documentation

- [EF - Legal Documentation Generator](https://www.eclipse.org/projects/tools/documentation.php?id=automotive.tractusx)
- [TractusX - Central Github Checks](https://eclipse-tractusx.github.io/docs/github-checks)
- [Tractus-X - Central GitHub Checks](https://eclipse-tractusx.github.io/docs/github-checks)
6 changes: 3 additions & 3 deletions docs/release/trg-7/trg-7-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: TRG 7.02 - License and Copyright header
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | Moved from OSS Development |
| Status | Created | Post-History |
|--------|-------------|----------------------------|
| Active | 13-Apr-2023 | Moved from OSS Development |

## Why

Expand Down
10 changes: 5 additions & 5 deletions docs/release/trg-7/trg-7-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: TRG 7.03 - IP checks for project content
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Draft | 13-Apr-2023 | Moved from OSS Development |
| Status | Created | Post-History |
|--------|-------------|----------------------------|
| Active | 13-Apr-2023 | Moved from OSS Development |

## Why

Expand Down Expand Up @@ -38,7 +38,7 @@ A Tractus-X committer **can** accept the contribution without further investigat

If not, a project committer **must** engage with the IP Team to request an [IP review for Code Contributions](/docs/oss/issues#eclipse-gitlab-ip-issue-tracker) by the IP Team before the contribution is pushed/merged.

Additionally check if the DEPENDENCY file is up-to-date, see [also](/docs/release/trg-7/trg-7-04):
Additionally, check if the DEPENDENCY file is up-to-date, see [also](/docs/release/trg-7/trg-7-04):

- Check for changes of the used libraries (e.g. pom files, package-lock.json, ...)
- Check for libraries with status "rejected", if present, the contribution must be rejected
Expand All @@ -48,7 +48,7 @@ Additionally check if the DEPENDENCY file is up-to-date, see [also](/docs/releas

Contributions made by Eclipse Tractus-X committers do not require review by the Eclipse IP Team and can be pushed directly into a project repository.

Recommenden way:
Recommended way:

- Push code to your feature branch
- Open PR to default branch
6 changes: 3 additions & 3 deletions docs/release/trg-7/trg-7-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: TRG 7.04 - IP checks for 3rd party content
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | Moved from OSS Development |
| Status | Created | Post-History |
|--------|-------------|----------------------------|
| Active | 13-Apr-2023 | Moved from OSS Development |

## Why

Expand Down
14 changes: 10 additions & 4 deletions docs/release/trg-7/trg-7-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: TRG 7.05 - Legal information for distributions
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | New |
| Status | Created | Post-History |
|--------|-------------|--------------|
| Active | 13-Apr-2023 | New |

## Why

Expand All @@ -15,8 +15,14 @@ The source of truth is always the [Eclipse Foundation Project Handbook](https://

## Description

License, notice and (if existing) DEPENDENCIES files, must be included in the root of every distribution artifact (e.g. JAR file). In the most general case, these files will appear in the root of distribution unit, but the exact location varies by technology type.
The following legal doc files must be included in every distribution artifact:

- LICENSE
- NOTICE.md
- DEPENDENCIES file(s) - if existing
- recommended: SECURITY.md

In the most general case, these files will appear in the root of distribution unit, but the exact location varies by technology type.
For content delivered as Java archive (JAR) files, for example, the legal files should be placed in the META-INF directory.

When the distribution is an individual file (e.g. JavaScript), the file must contain a header with copyright and license information, and the best effort must be undertaken to associate the file with the notices (e.g. a link to the source repository in the header).
Expand Down
8 changes: 4 additions & 4 deletions docs/release/trg-7/trg-7-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: TRG 7.06 - Legal notice for end user content
---

| Status | Created | Post-History |
|--------|-------------|---------------|
| Active | 13-Apr-2023 | New |
| Status | Created | Post-History |
|--------|-------------|--------------|
| Active | 13-Apr-2023 | New |

## Why

Expand Down Expand Up @@ -50,4 +50,4 @@ Regarding usage of this About card, it's recommended to add a json file to your

### Documentation

This section moved to TRG 7.07 and TRG 7.08.
This section moved to [TRG 7.07](/docs/release/trg-7/trg-7-07) and [TRG 7.08](/docs/release/trg-7/trg-7-08).
Loading

0 comments on commit b488b63

Please sign in to comment.