Skip to content

Commit 23c1374

Browse files
alext-mkrstingleby
authored andcommitted
docs: refresh README and contribution docs
Signed-off-by: Alex T <alext.mkrs@gmail.com>
1 parent d6f76ff commit 23c1374

3 files changed

Lines changed: 11 additions & 60 deletions

File tree

CONTRIBUTING

Lines changed: 0 additions & 44 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ iWater.
2929
```
3030
The developer community is invited to propose new interfaces for actuator types.
3131

32-
The UPM project is joining the Eclipse Foundation as an Eclipse IoT project.
33-
You can read more about this [here](https://projects.eclipse.org/proposals/eclipse-upm).
32+
The UPM project is an Eclipse Foundation IoT project.
33+
You can read more about this [here](https://projects.eclipse.org/projects/iot.upm).
3434

3535
### Example
3636

@@ -63,7 +63,7 @@ A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer
6363
}
6464
```
6565
66-
Browse through the list of all [examples](https://github.com/eclipse/upm/tree/master/examples).
66+
Browse through the list of all [examples](/examples/).
6767
6868
Multi-sensor samples for starter and specialized kits can be found in the
6969
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
@@ -77,7 +77,6 @@ Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) fro
7777
The UPM project includes support for multiple industrial-grade sensors, actuators, radios,
7878
protocols and standards in use today. It is also highly integrated with the Eclipse IDE
7979
through the help of the Foundation's partners.
80-
Learn more about [tools](https://software.intel.com/en-us/tools-by-segment/systems-iot).
8180
8281
### Installing UPM
8382
@@ -87,9 +86,6 @@ Find notes on how to install UPM on various OS'es on this [page](docs/installing
8786
8887
See building documentation [here](docs/building.md).
8988
90-
[![Build Status](https://travis-ci.org/intel-iot-devkit/upm.svg?branch=master)](https://travis-ci.org/intel-iot-devkit/upm)
91-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=upm-master&metric=alert_status)](https://sonarcloud.io/dashboard?id=upm-master)
92-
9389
### Guidelines and rules for new UPM contributions
9490
9591
Before you begin development, take a look at our naming [conventions](docs/naming.md).
@@ -99,8 +95,8 @@ Next, review the project's [contribution guide](docs/contributions.md).
9995
10096
Make sure you add yourself as an author on every new code file submitted.
10197
If you are providing a fix with significant changes, feel free to add yourself
102-
as a contributor. Signing-off your commits and accepting the ECA is mandatory
103-
for making new contributions to this project.
98+
as a contributor. Accepting the ECA is mandatory for making new contributions
99+
to this project.
104100
105101
Documenting your code is also a big part of the task. We have a strict set of
106102
tags used to classify our sensors and their capabilities. You can find out more

docs/contributions.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,20 @@ file:
3333
Eclipse Contributor Agreement
3434
============
3535

36-
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](http://www.eclipse.org/legal/ECA.php) in place.
36+
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](https://www.eclipse.org/legal/eca/) in place.
3737

3838
Here is the checklist for contributions to be considered _acceptable_:
3939

40-
1. [Create an account at Eclipse](https://dev.eclipse.org/site_login/createaccount.php).
40+
1. [Create an account at Eclipse](https://accounts.eclipse.org/user/register).
4141
2. Add your GitHub user name in your account settings.
42-
3. [Log into the project's portal](https://projects.eclipse.org/) and sign the ["Eclipse ECA"](https://projects.eclipse.org/user/sign/cla).
43-
4. Ensure that you [_sign-off_](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit) your Git commits.
42+
3. [Log in to the projects forge](https://www.eclipse.org/contribute/cla/) and sign the ["Eclipse ECA"](https://accounts.eclipse.org/user/eca).
4443
5. Ensure that you use the _same_ email address as your Eclipse account in commits.
4544
6. Include the appropriate copyright notice and license at the top of each file.
4645

47-
Your signing of the ECA will be verified by a webservice called 'ip-validation'
48-
that checks the email address that signed-off on your commits has signed the
46+
Your signing of the ECA will be verified by a Github Check called 'eclipsefdn/eca'
47+
that checks the email address that authored your commits has signed the
4948
ECA. **Note**: This service is case-sensitive, so ensure the email that signed
50-
the ECA and that signed-off on your commits is the same, down to the case.
49+
the ECA and that authored your commits is the same, down to the case.
5150

5251
Creating a new sensor library using the sensortemplate
5352
=======================================

0 commit comments

Comments
 (0)