Skip to content

Commit 373f974

Browse files
Merge pull request #856 from eclipse-tractusx/TRG_7_oss_gov_update
TRG 7: Updates to legal docs
2 parents 3e0c0a5 + 0d5d1a4 commit 373f974

File tree

10 files changed

+213
-129
lines changed

10 files changed

+213
-129
lines changed

docs/oss/issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ OR
4444
:::
4545

4646
There is the Otterdog self-service to manage the repositories in our organization.
47-
Otterdog is a tool to manage GitHub organizations at scale using a configuration as code approach. It is actively developed by the Eclipse Foundation and used to manage its numerous projects hosted on GitHub, see [here](https://gitlab.eclipse.org/eclipsefdn/security/otterdog).
47+
Otterdog is a tool to manage GitHub organizations at scale using a configuration as code approach. It is actively developed by the Eclipse Foundation and used to manage its numerous projects hosted on GitHub, see [here](https://github.com/eclipse-csi/otterdog).
4848

4949
See the [Otterdog Dashboard](https://eclipse-tractusx.github.io/.eclipsefdn/) with the tabs for the overview, the current configuration and the playground.
5050

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

+6-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ title: TRG 7.00 - Recurring activities for each PR
44

55
| Status | Created | Post-History |
66
|--------|-------------|--------------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
78
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
89
| | 13-Apr-2023 | Moved from OSS Development |
910

1011
## Why
1112

12-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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+
15+
The legal obligations of the content must be observed in all forms of which the content is available.
1316

1417
:::info
1518

@@ -20,7 +23,7 @@ The requirements described here must be met for each contribution.
2023
## Description
2124

2225
This is a summary of the most important requirements for OSS governance that you must follow.
23-
Before submitting a PR, contributors should verify compliance with the requirements. The reviewing commiter can only accept a PR if it is compliant.
26+
Before submitting a PR, contributors should verify compliance with the requirements. The reviewing committer can only accept a PR if it is compliant.
2427

2528
### Keep the following updated when creating a CatenaX / Tractus-X relevant release tag
2629

@@ -42,4 +45,4 @@ Before submitting a PR, contributors should verify compliance with the requireme
4245
- for libraries with status "restricted", the according IP issues must be present (issue number in the source column)
4346
- Legal information for distributions: [TRG 7.05](/docs/release/trg-7/trg-7-05)
4447
- Legal notice for end user content: [TRG 7.06](/docs/release/trg-7/trg-7-06)
45-
- Legal notice for end user content: [TRG 7.07](/docs/release/trg-7/trg-7-07), [TRG 7.08](/docs/release/trg-7/trg-7-08)
48+
- Legal notice for non-code: [TRG 7.07](/docs/release/trg-7/trg-7-07), [TRG 7.08](/docs/release/trg-7/trg-7-08)

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

+37-8
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ title: TRG 7.01 - Legal Documentation
44

55
| Status | Created | Post-History |
66
|--------|-------------|--------------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
78
| Active | 24-Aug-2023 | Updated SECURITY.md file |
89
| Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated |
910
| Active | 13-Apr-2023 | Moved from OSS Development |
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](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
14+
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)).
15+
16+
The legal obligations of the content must be observed in all forms of which the content is available.
1417

1518
This page contains information about legal documentation requirements in your repositories. The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc).
1619

@@ -25,27 +28,52 @@ The requirements described here **must** be met for each contribution.
2528
The following files must be part of your repository root folder:
2629

2730
- LICENSE
31+
- LICENSE_non-code
2832
- NOTICE.md
2933
- DEPENDENCIES
3034
- SECURITY.md
3135
- CONTRIBUTING.md
3236
- CODE_OF_CONDUCT.md
3337

34-
For examples look to the [Eclipse Tractus-X GitHub Organisation](https://github.com/eclipse-tractusx), e.g. the [APP Dashboard](https://github.com/eclipse-tractusx/app-dashboard).
38+
For examples look to the [Eclipse Tractus-X GitHub Organisation](https://github.com/eclipse-tractusx), e.g. the [sig-infra](https://github.com/eclipse-tractusx/sig-infra).
39+
40+
### LICENSE FILES
41+
42+
The Tractus-X project uses the following licenses:
43+
44+
- Apache-2.0 for code
45+
- CC-BY-4.0 for non-code
46+
47+
Both licenses have to be put on root level of each repository, [exampel](https://github.com/eclipse-tractusx/sig-infra).
48+
49+
**Exception:** Repositories that use ONLY the CC-BY-4.0 license, e.g. [sldt-semantic-models](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/NOTICE.md).
50+
In these repositories the CC-BY-4.0 license in the only license and the file is named LICENSE.
51+
52+
See the [Handbook#legaldoc-license](https://www.eclipse.org/projects/handbook/#legaldoc-license).
3553

36-
### LICENSE FILE
54+
#### LICENSE FILE
3755

38-
In Eclipse Tractus-X the primary outbound license is Apache-2.0.
56+
In Eclipse Tractus-X the outbound license for code is Apache-2.0.
3957

58+
- File name: LICENSE
4059
- SPDX-License-Identifier: Apache-2.0
4160
- [License Text](https://www.apache.org/licenses/LICENSE-2.0.txt)
4261

43-
See the [Handbook#legaldoc-license](https://www.eclipse.org/projects/handbook/#legaldoc-license).
62+
#### LICENSE_non-code FILE
63+
64+
The default license for non-code is the CC-BY-4.0.
65+
66+
- File name: LICENSE_non-code
67+
- SPDX-License-Identifier: CC-BY-4.0
68+
- [License Text](https://creativecommons.org/licenses/by/4.0/legalcode.txt)
4469

45-
For specifically defined documentation files the Creative Commons Attribution 4.0 International (CC BY 4.0) is required, see [TRG 7.08](trg-7-08.md).
70+
For more information, see [TRG 7.08](trg-7-08.md).
4671

4772
### NOTICE FILE
4873

74+
Do the following changes:
75+
76+
- Add both licenses to the "Declared Project Licenses" sections, see [example](https://github.com/eclipse-tractusx/sig-infra/blob/main/NOTICE.md)
4977
- Add the link to your repository
5078
- Add the link(s) to your SBOM, e.g. the DEPENDENCY file (one or more)
5179
- Add information for third party content checks, if not covered by the Dash Tool (e.g. IP checks for icons, fonts, ...)
@@ -93,7 +121,9 @@ In severe cases, you can also report a found vulnerability via mail or eclipse i
93121
See [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/projects/handbook/#vulnerability)
94122
```
95123

96-
### CONTRIBUTOR GUIDE
124+
### CONTRIBUTING FILE
125+
126+
Due to changes in the Eclipse Project Handbook, make sure that you have included the section "Terms of Use", see [the Legal Document Generator](https://www.eclipse.org/projects/tools/documentation.php?id=automotive.tractusx#contributing) or the [example](https://github.com/eclipse-tractusx/sig-infra/blob/main/CONTRIBUTING.md).
97127

98128
See the [Handbook#legaldoc-contributor](https://www.eclipse.org/projects/handbook/#legaldoc-contributor)
99129

@@ -103,7 +133,6 @@ See the [Handbook#legaldoc-contributor](https://www.eclipse.org/projects/handboo
103133

104134
The Version 2.0 of the Eclipse Foundation Community Code of Conduct was released on Jan 01, 2023.
105135
Update the file in your repositories.
106-
107136
:::
108137

109138
See the [CODE OF CONDUCT](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php)

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

+57-32
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
title: TRG 7.02 - License and Copyright header
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|----------------------------|
7-
| Active | 13-Apr-2023 | Moved from OSS Development |
5+
| Status | Created | Post-History |
6+
|--------|-------------|----------------------------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
8+
| Active | 24-Apr-2024 | Update of the year information in copyright header |
9+
| Active | 13-Apr-2023 | Moved from OSS Development |
810

911
## Why
1012

11-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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+
15+
The legal obligations of the content must be observed in all forms of which the content is available.
1216

1317
This page contains information about legal documentation requirements in your files. The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#ip-copyright-headers).
1418

@@ -22,22 +26,45 @@ The requirements described here **must** be met for each contribution.
2226

2327
*Where possible, all source code, property files, and metadata files (including application, test, and generated source code as well as other types of files such as XML, HTML, etc.) should contain appropriate copyright and license notices as well as information on each contribution.* (From the [Handbook#ip-copyright-headers](https://www.eclipse.org/projects/handbook/#ip-copyright-headers))
2428

25-
:::caution
29+
## Copyright and License Header
2630

27-
Update the year in the copyright header at the start of each new year!
31+
### Copyright Header
2832

29-
Example:
30-
Copyright (c) 202x, **`<new year>`** Contributors to the Eclipse Foundation
33+
It is recommended to use the generic copyright header:
3134

32-
:::
35+
```md
36+
Copyright (c) {year} Contributors to the Eclipse Foundation
37+
```
38+
39+
**Note:**
40+
41+
- The {year} is the year of the initial creation.
42+
- The contributors are identified via the GitHub commit logs (see NOTICE file)
43+
44+
Additionally copyright lines can be added (one or more times) to list specific copyright owner(s):
45+
46+
```md
47+
Copyright (c) 202x {owner}[ and others]
48+
```
49+
50+
**Examples:**
51+
52+
1. Copyright (c) 2021 Jane Doe
53+
- Copyright: Jane Doe
54+
1. Copyright (c) 2022 Jane Doe and others
55+
- others: somebody has made minor changes (e.g. fixed typos)
56+
57+
Do **not** remove the general line "Copyright (c) 202x Contributors to the Eclipse Foundation".
3358

34-
### Copyright and License Header
59+
### License Header
3560

36-
Example (Java):
61+
Never change the license section, except for the comment characters for the appropriate language.
62+
63+
#### Example for Apache-2.0 (Java)
3764

3865
```md
3966
/********************************************************************************
40-
* Copyright (c) 2021,2023 Contributors to the Eclipse Foundation
67+
* Copyright (c) 2023 Contributors to the Eclipse Foundation
4168
*
4269
* See the NOTICE file(s) distributed with this work for additional
4370
* information regarding copyright ownership.
@@ -56,28 +83,26 @@ Example (Java):
5683
********************************************************************************/
5784
```
5885

86+
#### Example for CC-BY-4.0
87+
88+
```md
89+
#######################################################################
90+
# Copyright (c) 2023 Contributors to the Eclipse Foundation
91+
#
92+
# See the NOTICE file(s) distributed with this work for additional
93+
# information regarding copyright ownership.
94+
#
95+
# This work is made available under the terms of the
96+
# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
97+
# which is available at
98+
# https://creativecommons.org/licenses/by/4.0/legalcode.
99+
#
100+
# SPDX-License-Identifier: CC-BY-4.0
101+
#######################################################################
102+
```
103+
59104
:::tip
60105

61106
Use your IDE's template mechanism to add the text automatically when you create new files.
62107

63108
:::
64-
65-
#### Copyright Header
66-
67-
You can also **add** the following line (one or more times) to identify the specific copyright owner(s):
68-
69-
Copyright (c) 202x,20yy {owner}[ and others]
70-
71-
Examples:
72-
73-
1. Copyright (c) 2021,2023 MyCompany GmbH
74-
- 2021, 2023 means from 2021 to 2023
75-
- Copyright: MyCompany GmbH
76-
1. Copyright (c) 2021,2023 MyCompany GmbH and others
77-
- others: somebody has made minor changes (e.g. fixed typos)
78-
79-
Do **not** remove the general line "Copyright (c) 202x,20yy Contributors to the Eclipse Foundation".
80-
81-
#### License Header
82-
83-
Never change the license section, except for the formatting characters for the appropriate language.

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

+7-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
title: TRG 7.03 - IP checks for project content
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|----------------------------|
7-
| Active | 13-Apr-2023 | Moved from OSS Development |
5+
| Status | Created | Post-History |
6+
|--------|-------------|-------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
8+
| Active | 13-Apr-2023 | Moved from OSS Development |
89

910
## Why
1011

11-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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.
1215

1316
This page contains information about legal obligations and checks of your project content. The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#ip-project-content).
1417

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

+9-6
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
title: TRG 7.04 - IP checks for 3rd party content
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|----------------------------|
7-
| Active | 13-Apr-2023 | Moved from OSS Development |
5+
| Status | Created | Post-History |
6+
|--------|-------------|-------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
8+
| Active | 13-Apr-2023 | Moved from OSS Development |
89

910
## Why
1011

11-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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.
1215

1316
This page contains information about legal obligations and checks of your 3rd party content. The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#ip-third-party).
1417

@@ -93,8 +96,8 @@ Make sure to also include test dependencies. For a maven-based java project you
9396
</executions>
9497
</plugin>
9598
</build>
96-
97-
99+
100+
98101
```
99102

100103
You then can invoke the plugin from command line as follows:

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

+7-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
title: TRG 7.05 - Legal information for distributions
33
---
44

5-
| Status | Created | Post-History |
6-
|--------|-------------|--------------|
7-
| Active | 13-Apr-2023 | New |
5+
| Status | Created | Post-History |
6+
|--------|-------------|-------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
8+
| Active | 13-Apr-2023 | New |
89

910
## Why
1011

11-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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.
1215

1316
The distribution form of software artifacts (often in a compiled form) generated from a project’s source code repositories must also include legal information.
1417
The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc-distribution).

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ title: TRG 7.06 - Legal notice for end user content
44

55
| Status | Created | Post-History |
66
|--------|-------------|--------------------------------------------|
7+
| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license |
78
| Active | 04-Dec-2023 | Update Shared UI Components / NPM library |
89
| Active | 13-Apr-2023 | New |
910

1011
## Why
1112

12-
Eclipse Tractus-X is an open source project hosted by the Eclipse Foundation licensed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0). The legal obligations of the content must be observed in all forms of which the content is available.
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+
15+
The legal obligations of the content must be observed in all forms of which the content is available.
1316

1417
All products delivered by the project—including executables, websites, documentation, and help must include certain notices. An executable might, for example, provide this information in an About Dialog; 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.
1518

0 commit comments

Comments
 (0)