Skip to main content

TRG 7.08 - Legal notice for KIT documentation (CC-BY-4.0)

StatusCreatedPost-History
Active25-Apr-2024Updates for CC-BY-4.0 license
Active18-Jul-2023CC-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 (Apache-2.0). For non-code the default license is the Creative Commons Attribution 4.0 International (CC-BY-4.0).

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

For specifically defined KIT documentation files the CC-BY-4.0 license is required.

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)

Description​

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 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.

See also the human-readable summary of the CC-BY-4.0.

Documentation​

Add a NOTICE section (post or preamble) into your dedicated documentation file, with the following information, here in md format:

## NOTICE

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 {Owner}
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir> (*)
- Images: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (**)

(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable

(**) Only, if you include self created images, see below

See here how to handle multiple copyright owners.

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.

Example:

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:

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 {owner}[ and others]
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (*)

(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable

Example:

project/
|__ docs/
|   |__ adoption-view.md
|   |__ img/
|      |__ image1.jpg
|      |__ image1.jpg.license
|      |__ image2.png
|      |__ image2.png.license
|__ LICENSE
|__ LICENSE_non-code

This is the recommended way of REUSE Software.

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.

- Images: https://github.com/eclipse-tractusx/<myrepo>/<link_to_image_or_image_dir> (*)

(*) URI or hyperlink to the Licensed Material to the extent reasonably practicable

Third-party content​

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