README.md 2.92 KB
Newer Older
1
2
# sparkplug.eclipse.org

Christopher Guindon's avatar
Christopher Guindon committed
3
The [https://sparkplug.eclipse.org](https://sparkplug.eclipse.org) website is generated with [Hugo](https://gohugo.io/documentation/). This project is a work in progress. 
4

5
The Eclipse Sparkplug Working Group seeks to drive the evolution and adoption of the Eclipse Sparkplug protocol and related MQTT-based technologies that enable the creation of open, collaborative, interoperable, and scalable Industrial IoT (IIoT) solutions and provide support for Industry 4.0.
6
7
8
9
10
11

## Getting started

Install dependencies, build assets and start a webserver:

```bash
12
yarn && hugo server
13
14
15
16
17
18
```

You can find guidance on the page-level metadata [here](https://eclipsefdn.github.io/hugo-solstice-theme/), and examples of the assorted page types (components) [here](https://eclipsefdn.github.io/hugo-solstice-theme/components/).

## Contributing

Christopher Guindon's avatar
Christopher Guindon committed
19
20
1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) the [sparkplug.eclipse.org](https://gitlab.eclipse.org/eclipsefdn/it/websites/sparkplug.eclipse.org) repository
2. Clone repository: `git clone https://gitlab.eclipse.org/[your_eclipsefdn_username]/sparkplug.eclipse.org.git`
21
22
23
3. Create your feature branch: `git checkout -b my-new-feature`
4. Commit your changes: `git commit -m 'Add some feature' -s`
5. Push feature branch: `git push origin my-new-feature`
Christopher Guindon's avatar
Christopher Guindon committed
24
6. Submit a merge request
25
26
27
28
29
30
31
32
33
34
35

### Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

## Related projects

Christopher Guindon's avatar
Christopher Guindon committed
36
### [EclipseFdn/solstice-assets](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets)
37
38
39

Images, less and JavaScript files for the Eclipse Foundation look and feel.

Christopher Guindon's avatar
Christopher Guindon committed
40
### [EclipseFdn/hugo-solstice-theme](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-solstice-theme/)
41
42
43
44
45

Hugo theme of the Eclipse Foundation look and feel. 

## Bugs and feature requests

Christopher Guindon's avatar
Christopher Guindon committed
46
47
Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://gitlab.eclipse.org/eclipsefdn/it/websites/sparkplug.eclipse.org/-/issues).

48
49
50
51
52
53
54
55
56
57
58
59
60
61

## Author

**Christopher Guindon (Eclipse Foundation)**

- <https://twitter.com/chrisguindon>
- <https://github.com/chrisguindon>

## Trademarks

* Jakarta and Jakarta EE are Trademarks of the Eclipse Foundation, Inc.
* Eclipse® is a Trademark of the Eclipse Foundation, Inc.
* Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

Christopher Guindon's avatar
Christopher Guindon committed
62

63
64
## Copyright and license

Christopher Guindon's avatar
Christopher Guindon committed
65
Copyright 2018-2022 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [sparkplug.eclipse.org authors](https://gitlab.eclipse.org/eclipsefdn/it/websites/sparkplug.eclipse.org/-/graphs/master). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://gitlab.eclipse.org/eclipsefdn/it/websites/sparkplug.eclipse.org/-/raw/master/README.md).