Skip to content

Commit 474017e

Browse files
committed
Improve regulations in TRG 7.07
Signed-off-by: Lars Geyer-Blaumeiser <[email protected]>
1 parent eebd6ca commit 474017e

File tree

3 files changed

+129
-142
lines changed

3 files changed

+129
-142
lines changed

docs/release/trg-7/trg-7-06.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: TRG 7.06 - Legal notice for end user content
44

55
| Status | Created | Post-History |
66
|--------|-------------|--------------------------------------------|
7+
| Draft | 27-Jun-2025 | Remove documentation section finally |
78
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
89
| Active | 04-Dec-2023 | Update Shared UI Components / NPM library |
910
| Active | 13-Apr-2023 | New |
@@ -53,7 +54,3 @@ Example:
5354
In order to align with the overall style guide, it's recommended to use the About card provided in the [Shared UI Components](https://eclipse-tractusx.github.io/portal-shared-components) via the respective [NPM library](https://www.npmjs.com/package/@catena-x/portal-shared-components) maintained by the portal product. As reference for the placement of this card in frontend apps: in the portal it has been integrated in an About page which is reachable from the footer.
5455

5556
Regarding usage of this About card, it's recommended to add a json file to your frontend project to be imported for the real content. As some of the content can only be determined in the build pipeline, you could add a json file as reference containing placeholder values. Those placeholder values could then be replaced, by script, just before the build within the build pipeline.
56-
57-
### Documentation
58-
59-
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).

docs/release/trg-7/trg-7-07.md

Lines changed: 125 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
---
2-
title: TRG 7.07 - Legal notice for non-code (e.g. documentation)
2+
title: TRG 7.07 - Legal notice for non-code (e.g. documentation, KITs)
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|------------------------------|
7-
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license|
8-
| Active | 18-Jul-2023 | Update: improved description |
9-
| | 13-Apr-2023 | Initial version |
5+
| Status | Created | Post-History |
6+
|--------|-------------|-------------------------------|
7+
| Draft | 27-06-2025 | Integration of non-code rules |
8+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
9+
| Active | 18-Jul-2023 | Update: improved description |
10+
| | 13-Apr-2023 | Initial version |
1011

1112
## Why
1213

13-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the Apache License 2.0 ([Apache-2.0](https://spdx.org/licenses/Apache-2.0)). For non-code the default license is the Creative Commons Attribution 4.0 International ([CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html)).
14+
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the Apache License 2.0
15+
([Apache-2.0](https://spdx.org/licenses/Apache-2.0)). For non-code the default license is the Creative Commons
16+
Attribution 4.0 International ([CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html)).
1417

1518
The legal obligations of the content must be observed in all forms of which the content is available.
1619

17-
All products delivered by the project—including websites, documentation, slides and help must include certain notices. Documentation might include a notice in either the pre- or post-amble, or a website might provide this information in a common footer, or a dedicated page. (From: [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc-end-user))
20+
All products delivered by the project—including websites, documentation, slides, KITS and help must include certain
21+
notices. Documentation might include a notice in either the pre- or post-amble, or a website might provide this
22+
information in a common footer, or a dedicated page.
23+
(From: [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc-end-user))
1824

1925
## Description
2026

2127
Eclipse Tractus-X allows the following licenses: Apache-2.0 and CC-BY-4.0 for non-code.
2228

23-
In this TRG, by non-code artifacts we mean e.g. documentation and images embedded in this documentation. All of these artifacts have to include notices about copyright, license and source location information. Excluded are the [legal documentation files](/docs/release/trg-7/trg-7-01#description).
29+
In this TRG, by non-code artifacts we mean e.g. documentation and images embedded in this documentation. All of these
30+
artifacts have to include notices about copyright, license and source location information. Excluded are the
31+
[legal documentation files](/docs/release/trg-7/trg-7-01#description).
2432

25-
The CC-BY-4.0 is the default license for non-code. For some documentation it may makes sense to put it under the Apache-2.0 license, especially for technical documentation with code snippets embedded.
26-
There are special cases for the **KIT documentation**, that **must** be licensed under the CC-BY-4.0, see TRG 7-08.
33+
The CC-BY-4.0 is the default license for non-code. Deviating from the default is an exceptional case! For some
34+
documentation, though, it may makes sense to put it under the Apache-2.0 license, especially for technical
35+
documentation with code snippets embedded. For the KIT documentation it is recommended to put it under the CC-BY-4.0.
36+
The following KIT documentation **MUST** be licensed under the CC-BY-4.0:
37+
38+
- Adoption View (adoption-view.md)
39+
40+
Self-created content embedded in the listed KIT documentation files under the CC-BY-4.0, have also to be licensed
41+
under the CC-BY-4.0. Generally self-created artifacts like images, graphics and logos should go under the CC-BY-4.0.
2742

2843
## How to include legal notices
2944

@@ -33,61 +48,138 @@ Attributions for non-code artifacts, like documentation files, have to be visibl
3348
it has to be added to the content, **NOT** in comments, metadata, or alt text (images).
3449
:::
3550

51+
See also the [human-readable summary of the CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
52+
3653
### Documentation
3754

38-
In this chapter we show an example of how to do it for a file with md format, licensed under the Apache-2.0, for other formats like slides, pdf, and others the format may be slightly different.
55+
For text files, like files in the markdown format, the attribution is done directly in the file as described in this
56+
section. The attribution is shown with an example for a CC-BY-4.0 licensed markdown file. For other formats like
57+
slides, pdf, and others adapt the information in an adequate way.
3958

4059
Add a `NOTICE` section (post or preamble) into your dedicated documentation file, with the following information:
4160

4261
```text
4362
## NOTICE
4463
45-
This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
46-
47-
- SPDX-License-Identifier: Apache-2.0
48-
- SPDX-FileCopyrightText: 202x {owner}[ and others]
49-
- SPDX-FileCopyrightText: 202xy Contributors to the Eclipse Foundation
50-
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir> (*)
51-
- Images: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (**)
52-
```
64+
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
5365
54-
(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable
66+
- SPDX-License-Identifier: CC-BY-4.0
67+
- SPDX-FileCopyrightText: 202x {Owner}
68+
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir> (+)
69+
```
5570

56-
(**) Only, if you include self created artifacts, see below
71+
(+) URI or hyperlink to the Licensed Material to the extent reasonably practicable
5772

5873
:::tip
59-
If there are multiple copyright holders, insert several SPDX-FileCopyrightText lines, for each entry one line. Explanations in brackets, do not copy. PLEASE.
74+
If there are multiple copyright holders, insert several SPDX-FileCopyrightText lines, for each entry one line.
75+
Explanations in brackets, do not copy. PLEASE.
6076

77+
```text
6178
- SPDX-FileCopyrightText: 2022 Owner1 (-> Owner1 created the content in 2022)
6279
- SPDX-FileCopyrightText: 2021 Owner2 (-> Owner2 created the content in 2021)
6380
- SPDX-FileCopyrightText: 2021 Contributors to the Eclipse Foundation
81+
```
82+
6483
:::
6584

66-
## Self-created content
85+
### Self-created content
86+
87+
Self-created non-text content like an image should have the copyright and license information included, whereever
88+
possible, e.g., the information can be added at the bottom of an image.
89+
90+
Example:
91+
92+
```text
93+
COPYRIGHT(C) 202x {owner}[ and others] | THIS WORK IS LICENSED UNDER A CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE (CC BY 4.0)
94+
```
95+
96+
If images (and other file types) cannot be attributed directly, attribution has to consider two distribution paths of
97+
the content.
98+
99+
#### Embedded content in a distributed document
100+
101+
If the file is embedded in a document, that is distributed as standalone document, e.g., as a generated PDF, the
102+
attribution **MUST** be done within the embedding document, either in the caption of the file, e.g., below the place
103+
the file is embedded, or in the notice section as described in the [previous section](#documentation). See an example
104+
for the notice section:
105+
106+
```text
107+
## NOTICE
67108
68-
Self-created content like images should have the copyright and license information included, where ever possible. Images should go under the CC-BY-4.0. See [TRG 7.08](/docs/release/trg-7/trg-7-08#self-created-content)
109+
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
110+
111+
- SPDX-License-Identifier: CC-BY-4.0
112+
- SPDX-FileCopyrightText: 2022 Owner1
113+
- Image(s): https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir>
114+
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir>
115+
116+
- SPDX-FileCopyrightText: 2022 Owner2
117+
- Diagram(s): https://github.com/eclipse-tractusx/<myrepo>/<link_to_diagram_or_diagram_dir>
118+
```
119+
120+
#### Repository Content
121+
122+
As the file is also provided in the repository and can be consumed there, the attribution **MUST** be done in the
123+
repository as well. This can be done with a workaround. Create a new file with the same name and the `.license` postfix
124+
next to the image with the following content:
125+
126+
```text
127+
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
128+
129+
- SPDX-License-Identifier: CC-BY-4.0
130+
- SPDX-FileCopyrightText: 202x {owner}[ and others]
131+
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (+)
132+
```
133+
134+
(+) URI or hyperlink to the Licensed Material to the extent reasonably practicable
135+
136+
**Example:**
137+
138+
```shell
139+
project/
140+
|__ docs/
141+
| |__ adoption-view.md
142+
| |__ img/
143+
| |__ image1.jpg
144+
| |__ image1.jpg.license
145+
| |__ image2.png
146+
| |__ image2.png.license
147+
|__ LICENSE
148+
|__ LICENSE_non-code
149+
```
150+
151+
This is the recommended way of [REUSE Software](https://reuse.software/tutorial/).
152+
153+
If multiple images need to be attributed, the REUSE Software project proposes the use of the `REUSE.toml` file format.
154+
This is an alternative way to specify attributions for many files that cannot be attributed directly like images. This
155+
file can be placed anywhere in a file system hierarchy and allows to refer to many files and provide the necessary
156+
attribution. As the whole concept is a bit more complex but very well described by the REUSE Software project, we refer
157+
at this point to the corresponding [specification](https://reuse.software/spec-3.3/#reusetoml) for further details.
69158

70159
### Third-party content
71160

72-
If you embed third-party content , e.g. images, graphics, logos in your artifacts, the images have to be attributed with the following information:
161+
If you third-party content, e.g. images, graphics, logos in your artifacts or repositories, the images have to be attributed
162+
with the following information:
73163

74164
- Title
75165
- Author/Copyright
76166
- License
77167
- Source
78168

79-
#### Where to put the attribution
169+
The attribution **MUST** be documented as described in the [previous section](#self-created-content), i.e., within the
170+
embedding artifact or using an extra file to store the information. In addition, reference the third-party content in
171+
the repositories NOTICE file at the root level
80172

81-
- right next to, over or under the image
82-
- **OR** make a clear reference to it and put the attribution in the NOTICE section
173+
**Example - photo with direct attribution:**
83174

84-
**Example - photo with attribution:**
175+
Direct attribution
85176

177+
```text
86178
![example](@site/static/img/oss_example_Creative_Commons_10th_Birthday.jpg)
87179
88-
Direct attribution:
89-
90-
["Creative Commons 10th Birthday Celebration San Francisco"](http://www.flickr.com/photos/sixteenmilesofstring/8256206923/in/set-72157632200936657) by [Timothy Vollmer](http://www.flickr.com/photos/sixteenmilesofstring/) is licensed under [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/)
180+
Attribution: ["Creative Commons 10th Birthday Celebration San Francisco"](http://www.flickr.com/photos/sixteenmilesofstring/8256206923/in/set-72157632200936657)
181+
by [Timothy Vollmer](http://www.flickr.com/photos/sixteenmilesofstring/) is licensed under [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)
182+
```
91183

92184
Addition for the notice section:
93185

docs/release/trg-7/trg-7-08.md

Lines changed: 3 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -4,112 +4,10 @@ title: TRG 7.08 - Legal notice for KIT documentation (CC-BY-4.0)
44

55
| Status | Created | Post-History |
66
|--------|-------------|---------------------------------------|
7+
| Decommisioned | 27-Jun-2025 | Integrated into 7.07 |
78
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
89
| Active | 18-Jul-2023 | CC-BY-4.0 topics moved here from 7.07 |
910

10-
## Why
11+
## Obsolete
1112

12-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the Apache License 2.0 ([Apache-2.0](https://spdx.org/licenses/Apache-2.0)). For non-code the default license is the Creative Commons Attribution 4.0 International ([CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html)).
13-
14-
The legal obligations of the content must be observed in all forms of which the content is available.
15-
16-
For specifically defined KIT documentation files the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) license is required.
17-
18-
All products delivered by the project - including websites, documentation, and help must include certain notices. Documentation might include a notice in either the pre- or post-amble, or a website might provide this information in a common footer, or a dedicated page. (From: [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc-end-user))
19-
20-
## Description
21-
22-
The CC-BY-4.0 is the default license for non-code. For some documentation it may makes sense to put it under the Apache-2.0 license, especially for technical documentation with code snippets embedded. For the KIT documentation it is recommended to put it under the CC-BY-4.0. The following KIT documentation **MUST** be licensed under the CC-BY-4.0:
23-
24-
- adoption-view.md(x)
25-
26-
Self-created content embedded in the listed KIT documentation files under the CC-BY-4.0, have also to be licensed under the CC-BY-4.0. Generally self-created artifacts like images, graphics and logos should go under the CC-BY-4.0.
27-
28-
## How to include legal notices
29-
30-
See also the [human-readable summary of the CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
31-
32-
### Documentation
33-
34-
Add a `NOTICE` section (post or preamble) into your dedicated documentation file, with the following information, here in md format:
35-
36-
```text
37-
## NOTICE
38-
39-
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
40-
41-
- SPDX-License-Identifier: CC-BY-4.0
42-
- SPDX-FileCopyrightText: 202x {Owner}
43-
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir> (*)
44-
- Images: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (**)
45-
```
46-
47-
(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable
48-
49-
(**) Only, if you include self created images, see below
50-
51-
See [here](/docs/release/trg-7/trg-7-07#documentation) how to handle multiple copyright owners.
52-
53-
### Self-created content
54-
55-
Self-created content like e.g. images should have the copyright and license information included, where ever possible. Images should go under the CC-BY-4.0.
56-
57-
Example:
58-
59-
```text
60-
COPYRIGHT(C) 202x {owner}[ and others] | THIS WORK IS LICENSED UNDER A CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE (CC BY 4.0)
61-
```
62-
63-
If images (and other formats) cannot be attributed directly, there is a workaround to provide the license and copyright information. Create a new file with the same name and the `.license` postfix next to the image with the following content:
64-
65-
```text
66-
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
67-
68-
- SPDX-License-Identifier: CC-BY-4.0
69-
- SPDX-FileCopyrightText: 202x {owner}[ and others]
70-
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (*)
71-
```
72-
73-
(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable
74-
75-
**Example:**
76-
77-
```shell
78-
project/
79-
|__ docs/
80-
| |__ adoption-view.md
81-
| |__ img/
82-
| |__ image1.jpg
83-
| |__ image1.jpg.license
84-
| |__ image2.png
85-
| |__ image2.png.license
86-
|__ LICENSE
87-
|__ LICENSE_non-code
88-
```
89-
90-
This is the recommended way of [REUSE Software](https://reuse.software/tutorial/).
91-
92-
If the images are not located in the same directory as the documentation, the notice section has to be extended for the information.
93-
Several lines for different locations can be added.
94-
95-
```text
96-
- Images: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (*)
97-
```
98-
99-
(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable
100-
101-
### Third-party content
102-
103-
If you embed third-party content, e.g. images, graphics, logos in your artifacts, the aerifacts have to be attributed with the following information:
104-
105-
- Title
106-
- Author/Copyright
107-
- License
108-
- Source
109-
110-
#### Where to put the attribution
111-
112-
- right next to, over or under the artifact (e.g. the image)
113-
- **OR** make a clear reference to it and put the attribution in the NOTICE section
114-
115-
Example: [TRG 7.07](/docs/release/trg-7/trg-7-07#third-party-content)
13+
Content has been integrated into TRG 7.07

0 commit comments

Comments
 (0)