diff --git a/docs/oss/issues.md b/docs/oss/issues.md index 46a692c26a8..8d5a0a11ba1 100644 --- a/docs/oss/issues.md +++ b/docs/oss/issues.md @@ -44,7 +44,7 @@ OR ::: There is the Otterdog self-service to manage the repositories in our organization. -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). +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). See the [Otterdog Dashboard](https://eclipse-tractusx.github.io/.eclipsefdn/) with the tabs for the overview, the current configuration and the playground. diff --git a/docs/release/trg-7/trg-7-00.md b/docs/release/trg-7/trg-7-00.md index 011d2b44350..94e86f98500 100644 --- a/docs/release/trg-7/trg-7-00.md +++ b/docs/release/trg-7/trg-7-00.md @@ -4,12 +4,15 @@ title: TRG 7.00 - Recurring activities for each PR | Status | Created | Post-History | |--------|-------------|--------------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | | Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated | | | 13-Apr-2023 | Moved from OSS Development | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. :::info @@ -20,7 +23,7 @@ The requirements described here must be met for each contribution. ## Description This is a summary of the most important requirements for OSS governance that you must follow. -Before submitting a PR, contributors should verify compliance with the requirements. The reviewing commiter can only accept a PR if it is compliant. +Before submitting a PR, contributors should verify compliance with the requirements. The reviewing committer can only accept a PR if it is compliant. ### Keep the following updated when creating a CatenaX / Tractus-X relevant release tag @@ -42,4 +45,4 @@ Before submitting a PR, contributors should verify compliance with the requireme - for libraries with status "restricted", the according IP issues must be present (issue number in the source column) - Legal information for distributions: [TRG 7.05](/docs/release/trg-7/trg-7-05) - Legal notice for end user content: [TRG 7.06](/docs/release/trg-7/trg-7-06) -- 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) +- 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) diff --git a/docs/release/trg-7/trg-7-01.md b/docs/release/trg-7/trg-7-01.md index f647bad7f5c..1a92f280c59 100644 --- a/docs/release/trg-7/trg-7-01.md +++ b/docs/release/trg-7/trg-7-01.md @@ -4,13 +4,16 @@ title: TRG 7.01 - Legal Documentation | Status | Created | Post-History | |--------|-------------|--------------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | | Active | 24-Aug-2023 | Updated SECURITY.md file | | Active | 20-Jul-2023 | References to TRG 7.07, 7.08 updated | | Active | 13-Apr-2023 | Moved from OSS Development | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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). @@ -25,27 +28,52 @@ The requirements described here **must** be met for each contribution. The following files must be part of your repository root folder: - LICENSE +- LICENSE_non-code - NOTICE.md - DEPENDENCIES - SECURITY.md - CONTRIBUTING.md - CODE_OF_CONDUCT.md -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). +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). + +### LICENSE FILES + +The Tractus-X project uses the following licenses: + +- Apache-2.0 for code +- CC-BY-4.0 for non-code + +Both licenses have to be put on root level of each repository, [exampel](https://github.com/eclipse-tractusx/sig-infra). + +**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). +In these repositories the CC-BY-4.0 license in the only license and the file is named LICENSE. + +See the [Handbook#legaldoc-license](https://www.eclipse.org/projects/handbook/#legaldoc-license). -### LICENSE FILE +#### LICENSE FILE -In Eclipse Tractus-X the primary outbound license is Apache-2.0. +In Eclipse Tractus-X the outbound license for code is Apache-2.0. +- File name: LICENSE - SPDX-License-Identifier: Apache-2.0 - [License Text](https://www.apache.org/licenses/LICENSE-2.0.txt) -See the [Handbook#legaldoc-license](https://www.eclipse.org/projects/handbook/#legaldoc-license). +#### LICENSE_non-code FILE + +The default license for non-code is the CC-BY-4.0. + +- File name: LICENSE_non-code +- SPDX-License-Identifier: CC-BY-4.0 +- [License Text](https://creativecommons.org/licenses/by/4.0/legalcode.txt) -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). +For more information, see [TRG 7.08](trg-7-08.md). ### NOTICE FILE +Do the following changes: + +- Add both licenses to the "Declared Project Licenses" sections, see [example](https://github.com/eclipse-tractusx/sig-infra/blob/main/NOTICE.md) - Add the link to your repository - Add the link(s) to your SBOM, e.g. the DEPENDENCY file (one or more) - 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 See [Eclipse Foundation Vulnerability Reporting Policy](https://www.eclipse.org/projects/handbook/#vulnerability) ``` -### CONTRIBUTOR GUIDE +### CONTRIBUTING FILE + +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). See the [Handbook#legaldoc-contributor](https://www.eclipse.org/projects/handbook/#legaldoc-contributor) @@ -103,7 +133,6 @@ See the [Handbook#legaldoc-contributor](https://www.eclipse.org/projects/handboo The Version 2.0 of the Eclipse Foundation Community Code of Conduct was released on Jan 01, 2023. Update the file in your repositories. - ::: See the [CODE OF CONDUCT](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php) diff --git a/docs/release/trg-7/trg-7-02.md b/docs/release/trg-7/trg-7-02.md index 31b6601373c..d630b1d0f9f 100644 --- a/docs/release/trg-7/trg-7-02.md +++ b/docs/release/trg-7/trg-7-02.md @@ -2,13 +2,17 @@ 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 | 25-Apr-2024 | Updates for CC-BY-4.0 license | +| Active | 24-Apr-2024 | Update of the year information in copyright header | +| Active | 13-Apr-2023 | Moved from OSS Development | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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). @@ -22,22 +26,45 @@ The requirements described here **must** be met for each contribution. *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)) -:::caution +## Copyright and License Header -Update the year in the copyright header at the start of each new year! +### Copyright Header -Example: -Copyright (c) 202x, **``** Contributors to the Eclipse Foundation +It is recommended to use the generic copyright header: -::: +```md +Copyright (c) {year} Contributors to the Eclipse Foundation + ``` + +**Note:** + +- The {year} is the year of the initial creation. +- The contributors are identified via the GitHub commit logs (see NOTICE file) + +Additionally copyright lines can be added (one or more times) to list specific copyright owner(s): + +```md +Copyright (c) 202x {owner}[ and others] + ``` + +**Examples:** + +1. Copyright (c) 2021 Jane Doe + - Copyright: Jane Doe +1. Copyright (c) 2022 Jane Doe and others + - others: somebody has made minor changes (e.g. fixed typos) + +Do **not** remove the general line "Copyright (c) 202x Contributors to the Eclipse Foundation". -### Copyright and License Header +### License Header -Example (Java): +Never change the license section, except for the comment characters for the appropriate language. + +#### Example for Apache-2.0 (Java) ```md /******************************************************************************** - * Copyright (c) 2021,2023 Contributors to the Eclipse Foundation + * Copyright (c) 2023 Contributors to the Eclipse Foundation * * See the NOTICE file(s) distributed with this work for additional * information regarding copyright ownership. @@ -56,28 +83,26 @@ Example (Java): ********************************************************************************/ ``` +#### Example for CC-BY-4.0 + +```md +####################################################################### +# Copyright (c) 2023 Contributors to the Eclipse Foundation +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This work is made available under the terms of the +# Creative Commons Attribution 4.0 International (CC-BY-4.0) license, +# which is available at +# https://creativecommons.org/licenses/by/4.0/legalcode. +# +# SPDX-License-Identifier: CC-BY-4.0 +####################################################################### + ``` + :::tip Use your IDE's template mechanism to add the text automatically when you create new files. ::: - -#### Copyright Header - -You can also **add** the following line (one or more times) to identify the specific copyright owner(s): - -Copyright (c) 202x,20yy {owner}[ and others] - -Examples: - -1. Copyright (c) 2021,2023 MyCompany GmbH - - 2021, 2023 means from 2021 to 2023 - - Copyright: MyCompany GmbH -1. Copyright (c) 2021,2023 MyCompany GmbH and others - - others: somebody has made minor changes (e.g. fixed typos) - -Do **not** remove the general line "Copyright (c) 202x,20yy Contributors to the Eclipse Foundation". - -#### License Header - -Never change the license section, except for the formatting characters for the appropriate language. diff --git a/docs/release/trg-7/trg-7-03.md b/docs/release/trg-7/trg-7-03.md index 90c92b4b867..bac2cb3bab4 100644 --- a/docs/release/trg-7/trg-7-03.md +++ b/docs/release/trg-7/trg-7-03.md @@ -2,13 +2,16 @@ title: TRG 7.03 - IP checks for project content --- -| Status | Created | Post-History | -|--------|-------------|----------------------------| -| Active | 13-Apr-2023 | Moved from OSS Development | +| Status | Created | Post-History | +|--------|-------------|-------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | +| Active | 13-Apr-2023 | Moved from OSS Development | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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). diff --git a/docs/release/trg-7/trg-7-04.md b/docs/release/trg-7/trg-7-04.md index 375ad562ae6..286973bb54b 100644 --- a/docs/release/trg-7/trg-7-04.md +++ b/docs/release/trg-7/trg-7-04.md @@ -2,13 +2,16 @@ 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 | 25-Apr-2024 | Updates for CC-BY-4.0 license | +| Active | 13-Apr-2023 | Moved from OSS Development | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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). @@ -93,8 +96,8 @@ Make sure to also include test dependencies. For a maven-based java project you - - + + ``` You then can invoke the plugin from command line as follows: diff --git a/docs/release/trg-7/trg-7-05.md b/docs/release/trg-7/trg-7-05.md index 7a8a70e96b5..ce7ce37afbd 100644 --- a/docs/release/trg-7/trg-7-05.md +++ b/docs/release/trg-7/trg-7-05.md @@ -2,13 +2,16 @@ title: TRG 7.05 - Legal information for distributions --- -| Status | Created | Post-History | -|--------|-------------|--------------| -| Active | 13-Apr-2023 | New | +| Status | Created | Post-History | +|--------|-------------|-------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | +| Active | 13-Apr-2023 | New | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. The distribution form of software artifacts (often in a compiled form) generated from a project’s source code repositories must also include legal information. The source of truth is always the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#legaldoc-distribution). diff --git a/docs/release/trg-7/trg-7-06.md b/docs/release/trg-7/trg-7-06.md index b99945c083b..8dde666ddfb 100644 --- a/docs/release/trg-7/trg-7-06.md +++ b/docs/release/trg-7/trg-7-06.md @@ -4,12 +4,15 @@ title: TRG 7.06 - Legal notice for end user content | Status | Created | Post-History | |--------|-------------|--------------------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | | Active | 04-Dec-2023 | Update Shared UI Components / NPM library | | Active | 13-Apr-2023 | New | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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. diff --git a/docs/release/trg-7/trg-7-07.md b/docs/release/trg-7/trg-7-07.md index 74fc31b30a4..2c744131f84 100644 --- a/docs/release/trg-7/trg-7-07.md +++ b/docs/release/trg-7/trg-7-07.md @@ -4,50 +4,38 @@ title: TRG 7.07 - Legal notice for non-code (e.g. documentation) | Status | Created | Post-History | |--------|-------------|------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license| | Active | 18-Jul-2023 | Update: improved description | | | 13-Apr-2023 | Initial version | ## Why -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. +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)). + +The legal obligations of the content must be observed in all forms of which the content is available. 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)) ## Description -Eclipse Tractus-X allows two outbound licenses: Apache-2.0 and CC-BY-4.0. -The outbound license is the `LICENSE` that resides at the root level of each repository. Unless otherwise noted, this is the default license for all self-created artifacts in the repository. For all repositories containing code, this is the Apache-2.0 license. An example for a repository licensed under the CC-BY-4.0 are the [semantic models](https://github.com/eclipse-tractusx/sldt-semantic-models). - -In this TRG, by non-code artifacts we mean 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 documenation files](/docs/release/trg-7/trg-7-01#description). - -There are special cases for the **KIT documentation**, that have to be licensed under the CC-BY-4.0, see TRG 7-08. - -## Location of secondary licenses - -If you use more then one outbound license, you have to put the "second" license to a `LICENSES/` directory.
-Naming: `.txt` +Eclipse Tractus-X allows the following licenses: Apache-2.0 and CC-BY-4.0 for non-code. -**Example:** Apache-2.0 as default license, CC-BY-4.0 as second license +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). -```shell -project/ -|__ LICENSE (<- Apache-2.0) -|__ LICENSES/ -| |__ CC-BY-4.0.txt -| ... -``` +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. +There are special cases for the **KIT documentation**, that **must** be licensed under the CC-BY-4.0, see TRG 7-08. ## How to include legal notices :::tip Think about "old-fashioned" printed documents:
-Attributions for non-code artefacts, like documentation files, have to be visible for the reciever, that means +Attributions for non-code artifacts, like documentation files, have to be visible for the receiver, that means it has to be added to the content, **NOT** in comments, metadata, or alt text (images). ::: ### Documentation -In this chapter we show an example of how to do it for the md format licensed under the Apache-2.0, for other formats like slides, pdf, and others the format may be slightly different. +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. Add a `NOTICE` section (post or preamble) into your dedicated documentation file, with the following information: @@ -57,32 +45,31 @@ Add a `NOTICE` section (post or preamble) into your dedicated documentation file This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 202x,202y -- SPDX-FileCopyrightText: 202x,202y Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/ +- SPDX-FileCopyrightText: 202x {owner}[ and others] +- SPDX-FileCopyrightText: 202xy Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx// (*) +- Images: https://github.com/eclipse-tractusx// (**) ``` +(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable + +(**) Only, if you include self created artifacts, see below + :::tip If there are multiple copyright holders, insert several SPDX-FileCopyrightText lines, for each entry one line. Explanations in brackets, do not copy. PLEASE. -- SPDX-FileCopyrightText: 2022,2023 MyCompany (-> MyCompany contributed from 2022 to 2023) -- SPDX-FileCopyrightText: 2021,2022 YourCompany (-> YourCompany contributed from 2021 to 2022) -- SPDX-FileCopyrightText: 2023 ThirdCompany (-> ThirdCompany contributed only in 2023) -- SPDX-FileCopyrightText: 2020,2023 AnotherCompany (-> AnotherCompany contributed from 2020 to 2023) -- SPDX-FileCopyrightText: 2021,2023 Contributors to the Eclipse Foundation +- SPDX-FileCopyrightText: 2022 Owner1 (-> Owner1 created the content in 2022) +- SPDX-FileCopyrightText: 2021 Owner2 (-> Owner2 created the content in 2021) +- SPDX-FileCopyrightText: 2021 Contributors to the Eclipse Foundation ::: -### Self-created images - -Self-created images have as default license the license at root level of your repository (as long you followed the guidelines of having a `LICENSES` directory for secondary licenses). +## Self-created content -If your documenation file and the images are in the same repository and have the default license and authorship/copyright is covered by the git history, the NOTICE section above is sufficient. - -If not, please see TRG 7.08. +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) ### Third-party content -If you embed third-party content (images) in your artefacts, the images have to be attributed with th following informations: +If you embed third-party content , e.g. images, graphics, logos in your artifacts, the images have to be attributed with the following information: - Title - Author/Copyright @@ -102,7 +89,9 @@ Direct attribution: ["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/) -Section for the notice file: +Addition for the notice section: + +Also add this section to the NOTICE file at root level, section "Third-party content" ```text ### Third-party content diff --git a/docs/release/trg-7/trg-7-08.md b/docs/release/trg-7/trg-7-08.md index 5f7bc6db226..f2674751935 100644 --- a/docs/release/trg-7/trg-7-08.md +++ b/docs/release/trg-7/trg-7-08.md @@ -4,40 +4,32 @@ title: TRG 7.08 - Legal notice for KIT documentation (CC-BY-4.0) | Status | Created | Post-History | |--------|-------------|---------------------------------------| +| Active | 25-Apr-2024 | Updates for CC-BY-4.0 license | | Active | 18-Jul-2023 | CC-BY-4.0 topics moved here from 7.07 | ## Why -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. +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)). -For specifically defined KIT documentation files the secondary license [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) is required. +The legal obligations of the content must be observed in all forms of which the content is available. -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)) +For specifically defined KIT documentation files the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) license is required. -## Description +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)) -In Eclipse Tractus-X the primary outbound license is Apache-2.0 for code repositories, so this is the default license. +## Description -For specifically defined KIT documentation files the CC-BY-4.0 license is required, these are: +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: - page_adoption_view.md(x) -Self-created images embedded in the listed KIT documentation files under the CC-BY-4.0, have also to be licensed under the CC-BY-4.0. - -## Location of the license - -If you use the CC-BY-4.0 license as "second" license, you have to put it to the `LICENSES/' directory.
- -- Naming: `CC-BY-4.0.txt` -- Content: [CC-BY-4.0 plaintext](https://creativecommons.org/licenses/by/4.0/legalcode.txt) - -More information in [TRG 7.07](/docs/release/trg-7/trg-7-07#location-of-the-license). +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. ## How to include legal notices See also the [human-readable summary of the CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). -### Documentation for KITs +### Documentation Add a `NOTICE` section (post or preamble) into your dedicated documentation file, with the following information, here in md format: @@ -47,43 +39,77 @@ Add a `NOTICE` section (post or preamble) into your dedicated documentation file This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 202x,202y -- Source URL: https://github.com/eclipse-tractusx/ +- SPDX-FileCopyrightText: 202x {Owner} +- Source URL: https://github.com/eclipse-tractusx// (*) +- Images: https://github.com/eclipse-tractusx// (**) ``` + (*) URI or hyperlink to the Licensed Material to the extent reasonably practicable + + (**) Only, if you include self created images, see below + See [here](/docs/release/trg-7/trg-7-07#documentation) how to handle multiple copyright owners. -### Self-created images +### Self-created content + +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. -As images (and other formats) cannot be edited, there is a workaround to provide the license and copyright information. For images under the CC-BY-4.0 license, create a new file with the same name and the `.license` postfix next to the image with the following content: +Example: + +```text +COPYRIGHT(C) 202x {owner}[ and others] | THIS WORK IS LICENSED UNDER A CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE (CC BY 4.0) +``` + +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: ```text This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 202x,202y -- Source URL: https://github.com/eclipse-tractusx/ +- SPDX-FileCopyrightText: 202x {owner}[ and others] +- Source URL: https://github.com/eclipse-tractusx// (*) ``` + (*) URI or hyperlink to the Licensed Material to the extent reasonably practicable + **Example:** ```shell project/ |__ docs/ | |__ adoption-view.md -| |__ img/ -| |__ image1.jpg -| |__ image1.jpg.license -| |__ image2.png -| |__ image2.png.license +| |__ img/ +| |__ image1.jpg +| |__ image1.jpg.license +| |__ image2.png +| |__ image2.png.license |__ LICENSE -|__ LICENSES/ -| |__ CC-BY-4.0.txt -| ... +|__ LICENSE_non-code ``` This is the recommended way of [REUSE Software](https://reuse.software/tutorial/). +If the images are not located in the same directory as the documentation, the notice section has to be extended for the information. +Several lines for different locations can be added. + +```text +- Images: https://github.com/eclipse-tractusx// (*) + ``` + + (*) URI or hyperlink to the Licensed Material to the extent reasonably practicable + ### Third-party content -See [TRG 7.07](http://localhost:3000/docs/release/trg-7/trg-7-08#embedding-third-party-content-in-documentation-artefacts) +If you embed third-party content, e.g. images, graphics, logos in your artifacts, the aerifacts have to be attributed with the following information: + +- Title +- Author/Copyright +- License +- Source + +#### Where to put the attribution + +- right next to, over or under the artifact (e.g. the image) +- **OR** make a clear reference to it and put the attribution in the NOTICE section + +Example: [TRG 7.07](/docs/release/trg-7/trg-7-07#third-party-content)