Project Information

• 1: Community
• 2: Dependencies
• 3: Contribution Guidelines
• 4: Project Logo
• 5: Privacy Information
• 6: Security Policy

1 - Community

Thanks for your interest in this project and in our community.

• https://projects.eclipse.org/projects/automotive.leda

Contact

Contact the project developers via the project’s “dev” list.

• https://accounts.eclipse.org/mailing-list/leda-dev

Developer resources

Information regarding source code management, builds, coding standards, and more.

• https://projects.eclipse.org/projects/automotive.leda/developer

The project maintains the following source code repositories

• https://github.com/eclipse-leda/leda
• https://github.com/eclipse-leda/leda-distro
• https://github.com/eclipse-leda/meta-leda

Publications

• Eclipse Leda Introduction Video - YouTube, 2min
• Eclipse SDV - First Contribution Day (June 2022) - Session Recording, YouTube, 26min
• Eclipse SDV - Second Contribution Day (September 2022) - Session Recording, YouTube, 30min
• Eclipse Leda - Slides SDV Contribution Day - September 2022 - Slides (PDF)

2 - Dependencies

3 - Contribution Guidelines

Thanks for considering to contribute to Eclipse Leda. We really appreciate the time and effort you want to spend helping to improve the project.

In order to get you started as fast as possible we need to go through some organizational issues first, though.

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

• https://eclipse.org/projects/dev_process
• https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

• http://www.eclipse.org/legal/ECA.php

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit

Making Your Changes

• Fork the repository on GitHub.
• Create a new branch for your changes.
  • Note: When forking multiple repositories (eg most of the time, you also need to make modifications to meta-leda), please use the same branch name of each repository.
• Make your changes following the code style guide for the respective type of content:
  • BitBake Recipes: https://www.openembedded.org/wiki/Styleguide
  • Documentation: https://www.docsy.dev/docs/best-practices/
  • Shell Scripts (Example Style Guide): https://google.github.io/styleguide/shellguide.html
• When you create new files make sure you include a proper license header at the top of the file (see License Header section below).
• Make sure you include test cases for non-trivial features.
• Make sure the test suite passes after your changes.
• Commit your changes into that branch.
• Use descriptive and meaningful commit messages. Start the first line of the commit message with the a GitHub Issue number if available and a title e.g. [#9865] Add token based authentication.
• Squash multiple commits that are related to each other semantically into a single one.
• Make sure you use the -s flag when committing as explained above.
• Push your changes to your branch in your forked repository.
• Once you’re satisfied with your contribution, open a Pull Request and Eclipse Leda Committers will start with the review of your changes.
  • Note: When working with multiple repositories, you need to open separate Pull Requests for each repository.

Adding Documentation to Hugo

• Add the markdown document to the appropriate folder in the path leda/content/en.
• Add the front-matter

---
title: "title of the file"
date: 2022-05-09T13:43:25+05:30
---

• Additional front matter that can be added –
  • url : "specifying a definite url to the file"
  • weight : 10 (used for ordering your content in lists. Lower weight gets higher precedence.)
• The images need to be put in path leda/static/assets. The image reference should be /assets/image.jpg in the markdown file. (Note: Do not use relative paths or url)
• In case you are creating a new folder, create _index.md file with the front matter only.

Running Locally

• Install hugo version 0.98.0 extended Release v0.98.0 · gohugoio/hugo (github.com)
• Install Docsy theme in the path leda/themes/docsy –

#Run this command from root directory of velocitas-docs
git clone https://github.com/google/docsy.git themes/docsy

• Install pre-requisites

cd themes/docsy/userguide/
npm install
npm install --save-dev postcss

• From the leda directory run the command hugo server visit localhost:1313 to see the rendered static site.

Submitting the Changes

Submit a pull request via the normal GitHub UI.

After Submitting

• Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.

License Header

Please make sure any file you newly create contains a proper license header like this:

# /********************************************************************************
# * Copyright (c) 2022 Contributors to the Eclipse Foundation
# *
# * See the NOTICE file(s) distributed with this work for additional
# * information regarding copyright ownership.
# *
# * This program and the accompanying materials are made available under the
# * terms of the Apache License 2.0 which is available at
# * https://www.apache.org/licenses/LICENSE-2.0
# *
# * SPDX-License-Identifier: Apache-2.0
# ********************************************************************************/

You should, of course, adapt this header to use the specific mechanism for comments pertaining to the type of file you create.

Important

Please do not forget to add your name/organization to the LICENSE file’s Copyright Holders section. If this is not the first contribution you make, then simply update the time period contained in the copyright entry to use the year of your first contribution as the lower boundary and the current year as the upper boundary, e.g.

Copyright 2017, 2018 ACME Corporation

Build

• On every PR merge a pipeline run will be triggered. This run will trigger the hugo docs build
• Hugo v0.98.0 extended is set up for the runner
• Docsy theme is setup for beautification of static site
• Then dependencies are installed for the theme
• Static site is generated and stored in a folder "public"
• The contents of public are committed to gh_pages branch which is exposed to host the github pages

4 - Project Logo

Download eclipse-leda-logo.zip

For Screen

White background

Black background

For Print

Colors

• Primary Color: #6daed1
• Secondary Color: #804096

5 - Privacy Information

Your privacy is important to us. The following Information is to provide you with all information relevant to data protection in order to be able to use the software, in a data protection compliant manner. It is provided as an information source for your solution-specific data protection and data privacy topics. This is not intended to provide and should not be relied on for legal advice.

Your Role

First things first: when you choose and use our software, you are most likely acting in the role of data controller, if personal related data is being processed. Therefore, you must ensure that the processing of personal data complies with the respective local legal requirements, e.g. when processing data within the scope of General Data Protection Regulation (GDPR) the legal requirements for a controller from the GDPR.

Where may the processing of personal related data be relevant?

When using our software in combination with other software components, personal data or data categories may be collected for the purpose of developing, testing and running in-vehicle applications (Vehicle Apps). Possible examples are the vehicle identification number (VIN), the number plate, GPS data, video data, audio data, or other measurement data. You can determine which data or data categories are collected when configuring the software. These data are stored in volatile memory and are deleted by shutting down the system. You are responsible for the compliant handling of the data in accordance with the applicable local law.

What have we done to make the software data protection friendly?

This section describes the measures taken to integrate the requirements of the data protection directly into the software development. The technical measures described below follow a “privacy by design” approach.

• Local data: The software may save data permanently in local virtual storage (eg when run in QEMU Emulator) or on local physical storage (SD-Card on Raspberry PI). All collected or processed data can be deleted by either deleting the virtual storage file (*.qcow2), or by erasing the SD-Card.

• Cloud storage: The software may send data to cloud endpoints controlled by you or your organization. Examples include connectivity data, device identification, device health, device telemetry, application metrics and application logs. Collection and processing of example data on the device is enabled by default. Sending of device data to cloud endpoints must be explicitly enabled by performing the device provisioning process. The actual cloud endpoints are determined and configured during the device provisioning process. All collected or processed data can be deleted on the cloud side in the respective cloud endpoints.

• Vulnerabilities: The release process for this software is set up to always update to the newest package updates. The project will continously release new versions of the software. To protect personal data, it is advisable to always use the latest version of the software.

• Important: When you use the Eclipse Leda quickstart images for non-volatile setups, it is essential to reconfigure the system and harden it, this includes but is not limited to the following configuration items:

  • Disable system user (root) password and login
  • Disable SSH login with password
  • Adding a new Linux user with restricted permissions
  • Adding SSH key based authentication
  • Container Resources and Configurations: Secrets, such as Device Identity Certificates for Cloud Connection and Access credentials for private Container Registries

6 - Security Policy

This project implements the Eclipse Foundation Security Policy

• https://www.eclipse.org/security

Reporting a Vulnerability

Please report vulnerabilities to the Eclipse Foundation Security Team at security@eclipse.org

Supported Yocto Versions

Important: When you use the quickstart images for non-volatile setups, it is essential to reconfigure the system and harden it.

Configuration Items

• Disable system user (root) password and login
• Disable SSH login with password
• Adding a new Linux user with restricted permissions
• Adding SSH key based authentication
• Container Secrets
  • Device identity certificates for cloud connection
  • Access credentials for private container registries

Device Identity for Cloud Connector