You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
54
55
55
56
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).
| 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 |
10
11
11
12
## Why
12
13
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)).
14
17
15
18
The legal obligations of the content must be observed in all forms of which the content is available.
16
19
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))
18
24
19
25
## Description
20
26
21
27
Eclipse Tractus-X allows the following licenses: Apache-2.0 and CC-BY-4.0 for non-code.
22
28
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
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.
27
42
28
43
## How to include legal notices
29
44
@@ -33,61 +48,138 @@ Attributions for non-code artifacts, like documentation files, have to be visibl
33
48
it has to be added to the content, **NOT** in comments, metadata, or alt text (images).
34
49
:::
35
50
51
+
See also the [human-readable summary of the CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
52
+
36
53
### Documentation
37
54
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.
39
58
40
59
Add a `NOTICE` section (post or preamble) into your dedicated documentation file, with the following information:
41
60
42
61
```text
43
62
## NOTICE
44
63
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
(**) Only, if you include self created artifacts, see below
71
+
(+) URI or hyperlink to the Licensed Material to the extent reasonably practicable
57
72
58
73
:::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.
60
76
77
+
```text
61
78
- SPDX-FileCopyrightText: 2022 Owner1 (-> Owner1 created the content in 2022)
62
79
- SPDX-FileCopyrightText: 2021 Owner2 (-> Owner2 created the content in 2021)
63
80
- SPDX-FileCopyrightText: 2021 Contributors to the Eclipse Foundation
81
+
```
82
+
64
83
:::
65
84
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
67
108
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).
["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/)
| Decommisioned | 27-Jun-2025 | Integrated into 7.07 |
7
8
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
8
9
| Active | 18-Jul-2023 | CC-BY-4.0 topics moved here from 7.07 |
9
10
10
-
## Why
11
+
## Obsolete
11
12
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).
(*) 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]
0 commit comments