Skip to content

Commit 5bb85f9

Browse files
committed
Make contribution document visible and update repo list
1 parent 8554924 commit 5bb85f9

File tree

6 files changed

+32
-92
lines changed

6 files changed

+32
-92
lines changed

config/_default/config.toml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,32 @@ paginate = 10
2626

2727
[[menu.main]]
2828
name = "Vision"
29-
url = "/about/"
29+
url = "/about"
3030
weight = 15
3131

3232
[[menu.main]]
3333
name = "Quickstart"
3434
url = "/quickstart"
3535
weight = 16
3636

37+
[[menu.main]]
38+
name = "Contributing"
39+
url = "/contributing"
40+
weight = 18
41+
3742
[[menu.main]]
3843
name = "Blog"
39-
url = "/blog/"
44+
url = "/blog"
4045
weight = 20
4146

4247
[[menu.main]]
4348
name = "Videos & Publications"
44-
url = "/publications/"
49+
url = "/publications"
4550
weight = 30
4651

4752
[[menu.main]]
4853
name = "Resources"
49-
url = "/resources/"
54+
url = "/resources"
5055
weight = 40
5156

5257

config/staging/config.toml

Lines changed: 0 additions & 1 deletion
This file was deleted.

content/blog/2018-10-22-ece1018ese1218.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Eclipse Kuksa and its latest development activities will be presented along with
1212

1313
## Embedded Software Engineering Kongress 2018
1414

15-
In addition to the EclipseCon Europe event, you can join us at the **ESE Kongress** in Sindelfingen, Germany, on December, 6th. The talk [Überwindung der Silos – Revolution für vernetzte Fahrzeuge](https://www.ese-kongress.de/paper/presentation/id/78), that means 'Overcoming the Silos - Revolution for Connected Vehicles', will be held at 16:45 o'clock (4:45pm) and will cover both a generic as well as detailed descriptions of the three Eclipse Kuksa platforms (a) In-Vehicle, (b) IDE, and ( c) Cloud.
15+
In addition to the EclipseCon Europe event, you can join us at the **ESE Kongress** in Sindelfingen, Germany, on December, 6th. The talk "Überwindung der Silos – Revolution für vernetzte Fahrzeuge", that means 'Overcoming the Silos - Revolution for Connected Vehicles', will be held at 16:45 o'clock (4:45pm) and will cover both a generic as well as detailed descriptions of the three Eclipse Kuksa platforms (a) In-Vehicle, (b) IDE, and ( c) Cloud.

content/contributing.md

Lines changed: 19 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,7 @@ date: 2019-01-29T09:46:31+02:00
44
draft: false
55
---
66

7-
**Get in touch** ! There is the
8-
### [kuksa-dev mailing list](https://accounts.eclipse.org/mailing-list/kuksa-dev) and a
9-
### **bi-weekly** [Zoom meeting](https://eclipse.zoom.us/j/537310990) every Thursday on even calendar weeks from 1-2pm (CET/CEST).
10-
11-
-----------
12-
-----------
13-
14-
15-
# HowTo contribute to Eclipse Kuksa
7+
# How to contribute to Eclipse Kuksa
168
Great that you are interested in contributing to Eclipse Kuksa.
179
We really looking forward to receive your contribution!
1810

@@ -24,13 +16,11 @@ In the project we agreed upon the following approach to add contributions to the
2416
4. Clearly outline third party dependencies
2517

2618
## Definition of Done
19+
2720
First, we have DoD for solved issues. Please check if you met all the items in the following list:
2821

2922
* File headers in file OK (see section [License Headers](#licensing-and-file-header) for details)
3023

31-
* Each new feature is developed in a separate branch
32-
* Development branches should be named like`<github-nickname>/<issue>/<description>`, e.g. bs-jokri/#2/fix-connection-handling
33-
3424
* Coding style
3525
* Clean code is encouraged (see ‘Clean Code’ by Robert C. Martin or the
3626
[Clean Code Cheatsheet](https://www.bbv.ch/images/bbv/pdf/downloads/V2_Clean_Code_V3.pdf).
@@ -42,15 +32,13 @@ First, we have DoD for solved issues. Please check if you met all the items in t
4232

4333
* All tests pass
4434
* Unit testing as it is already present
45-
* You have more - use them!
35+
* If you have more - contribute them!
4636

4737
* Documentation
4838
* Provide the necessary technical documentation of your feature in the respective
4939
Github repository that you contribute to. Documentation is in markdown and it either
5040
included in the top-level README.md file of the Github repository, or linked from
5141
there.
52-
* Update the high-level overview of Kuksa in the [kuksa.integration Wiki at Github](https://github.com/eclipse/kuksa.integration/wiki).
53-
From the wiki, provide links to relevant technical documentation in the Github repositories.
5442

5543
* Commit style
5644
* Please write brief and useful commit messages: Separate the subject from body with a blank line because the subject line
@@ -70,7 +58,7 @@ First, we have DoD for solved issues. Please check if you met all the items in t
7058
If you checked your code according to the DoD and you feel it can be merged to master, please create a PR to master.
7159
Each PR that is merged to master has to pass all tests and needs a code review of some other person of the project that looks onto your contribution from another angle,
7260
i.e. didn't work with you on the new feature. Probably a good idea is to have someone from another organization doing the review.
73-
Maybe you already have someone in mind doing the review, then request a review from this person via the github review functionallity.
61+
Eclipse Kuksa Committers regularly scan the repositories for new Pull Requests.
7462

7563
## Review
7664
If you conduct a code review, please look at the following issues:
@@ -81,60 +69,36 @@ If you conduct a code review, please look at the following issues:
8169
* Does the new feature fit the overall project goal, is it suitable for the community
8270

8371
## Manual Test
84-
If applicable the new feature should at least be deployed and tested by someone before actually merged to master.
85-
This could be done by the same person that is doing the review but could be performed by another person.
86-
72+
If applicable the new feature should at least be deployed and tested by someone before actually merged to master.
73+
This could be done by the same person that is doing the review but could be performed by another person.
8774

8875
After review and tests are finished it should be documented who actually did the review and the test.
89-
Do this with the following lines in the comments of the PR.
90-
```
91-
92-
```
93-
and
94-
```
95-
96-
```
97-
98-
## Third party dependencies
99-
100-
If you use third party content (import / include ...), you are required to list each third party content explicitly with its version number in the documentation or your pull-request comment.
101-
Please note that GPL software cannot be approved for Eclipse Kuksa.
76+
Use the GitHub review mechanism and give comment stating what you have done.
10277

10378
## Licensing and file header
10479

10580
All files contributed require headers - this will ensure the license and copyright clearing at the end.
10681
Also, all contributions must have the same license as the original source.
10782

108-
If a file has relevant functionality add the official EPL-2.0 header as described here
109-
https://www.eclipse.org/legal/epl-2.0/faq.php#h.q72cnghf29k0
110-
111-
We recommend to use the releng copyright tool at:
112-
https://wiki.eclipse.org/Development_Resources/How_to_Use_Eclipse_Copyright_Tool
83+
Most Eclipse KUKSA repositories use the [Apache-2.0 ](https://www.apache.org/licenses/LICENSE-2.0) license.
84+
A header like the one below shall be used.
11385

11486
```
115-
/*********************************************************************
116-
* Copyright (c) {date} {owner} [and others]
87+
/********************************************************************************
88+
* Copyright (c) {year} Contributors to the Eclipse Foundation
89+
*
90+
* See the NOTICE file(s) distributed with this work for additional
91+
* information regarding copyright ownership.
11792
*
118-
* This program and the accompanying materials are made
119-
* available under the terms of the Eclipse Public License 2.0
120-
* which is available at https://www.eclipse.org/legal/epl-2.0/
93+
* This program and the accompanying materials are made available under the
94+
* terms of the Apache License 2.0 which is available at
95+
* http://www.apache.org/licenses/LICENSE-2.0
12196
*
122-
* SPDX-License-Identifier: EPL-2.0
123-
**********************************************************************/
97+
* SPDX-License-Identifier: Apache-2.0
98+
********************************************************************************/
12499
```
125100
(please adapt comment characters usage)
126101

127-
For small files such as property files, configuration files or standard XML files:
128-
129-
```
130-
# Copyright <COPYRIGHT_HOLDER>, <YEAR>. Part of the Eclipse Kuksa Project.
131-
#
132-
# All rights reserved. This configuration file is provided to you under the
133-
# terms and conditions of the Eclipse Distribution License v1.0 which
134-
# accompanies this distribution, and is available at
135-
# http://www.eclipse.org/org/documents/edl-v10.php
136-
```
137-
138102
## Eclipse Contributor Agreement
139103

140104
Before your contribution can be accepted by the project team contributors must

content/resources.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,8 @@ You can reach us on the [kuksa-dev mailing list](https://accounts.eclipse.org/ma
2020

2121
# Get the code
2222

23-
The code for the various subprojects is provided in the following Github repositories. Please note that
23+
The code for the various subprojects is provided in Github repositories. Please note that
2424
issues are tracked and discussed in the repository of the respective sub-project.
2525

26-
## Active projects
27-
{{<table "table table-striped table-bordered">}}
28-
| Component | Source | Description |
29-
|--------------------------|-------------------------------------------|----------|
30-
| Eclipse KUKSA.val |https://github.com/eclipse/kuksa.val | KUKSA Vehicle Abstraction Layer, this is a an implementation of a VSS server provding access to in-vehicle signals using VISS or GRPC interfaces |
31-
| Eclipse KUKSA.val.feeders |https://github.com/eclipse/kuksa.val.feeders | Multiple data and actuation providers, gathering vehicle data and transforming it to VSS suitable for KUKSA.val |
32-
| Eclipse KUKSA.val.services | https://github.com/eclipse/kuksa.val.services | Set of example vehicle services |
33-
| Eclipse KUKSA Android SDK | https://github.com/eclipse-kuksa/kuksa-android-sdk | SDK to develop KUKSA clients on Android using Kotlin or Java |
34-
| Eclipse KUKSA Android Companion | https://github.com/eclipse-kuksa/kuksa-android-companion | Example App using the Android SDK to check and control temperature, tire pressure, doors etc. from your phone |
35-
| Eclipse KUKSA Python SDK | https://github.com/eclipse-kuksa/kuksa-python-sdk | SDK to develop KUKSA applications and providers using Python. Also includes a versatile CLI client for testing/debugging |
36-
| Eclipse KUKSA.hardware | https://github.com/eclipse-kuksa/kuksa-hardware |Hardware schematics and manufacturing files for the KUKSA SDV prototpying platform. This is a PI-compatible hardware providing access to CAN, OBD and cellular connectivity |
37-
| KUKSA-website | https://github.com/eclipse-kuksa/kuksa-website | The sources for the website you are reading now |
38-
{{< /table >}}
39-
40-
## Dormant projects
41-
This repositories contain components that have been developed in the past, but are currently not actively maintained or whose functionality has been integrated into active components.
42-
43-
44-
45-
{{<table "table table-striped table-bordered">}}
46-
47-
| Component | Source | Description |
48-
|--------------------------|--------------------------------------------|----------|
49-
| Eclipse KUKSA.ide | https://github.com/eclipse/kuksa.ide | Browser-based IDE used by developers to create applications for the Eclipse Kuksa in-vehicle. If you are searching for an integrated way to build applications based on vehicle data provided by KUKSA.val, you may want to check the [Velocitas framework](https://eclipse-velocitas.github.io/velocitas-docs/). As first step you can have a look at the playground from [digital auto](https://digitalauto.netlify.app/). |
50-
| KUKSA.Apps | https://github.com/eclipse/kuksa.apps | Contains applications to showcase use-cases of Eclipse KUKSA. Demos regarding vehicle signal access have been moved over to [KUKSA.val](https://github.com/eclipse/kuksa.val) |
51-
| KUKSA.In-Vehicle | https://github.com/eclipse/kuksa.invehicle | The in-vehicle platform of Eclipse Kuksa. The KUKSA hardware has been moved to [KUKSA.hardware](https://github.com/eclipse/kuksa.hardware), the VISS dataserver for accessing in-vehicle data is further developed in [KUKSA.val](https://github.com/eclipse/kuksa.val ). For a modern integrated SDV distribution check [Eclipse LEDA](https://eclipse-leda.github.io/leda/) |
52-
| Eclipse KUKSA.cloud | https://github.com/eclipse/kuksa.cloud | The cloud-backend of Eclipse KUKSA, including the App Store. Provides helmcharts for easy deployment of the KUKSA.cloud. For deploying software in a vehicle check [Eclipse Kanto](https://github.com/eclipse-kanto) or other pojects in [Eclipse SDV](https://sdv.eclipse.org/). For updated versions of the components utilized in KUKSA.cloud check [Eclipse IoT packages](https://github.com/eclipse/packages) |
53-
{{< /table >}}
54-
26+
Please visit [Eclipse Kuksa](https://github.com/eclipse-kuksa) on Github to explore all repositories!
5527

data/clients/EclipseVelocitas.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
name: "Eclipse Velocitas"
22
image: "img/clients/velocitas-h180.png"
3-
url: "https://websites.eclipseprojects.io/velocitas/"
3+
url: "https://projects.eclipse.org/projects/automotive.velocitas"

0 commit comments

Comments
 (0)