Skip to content

Latest commit

 

History

History
117 lines (78 loc) · 4.86 KB

README.md

File metadata and controls

117 lines (78 loc) · 4.86 KB
Raw

iot.eclipse.org

The iot.eclipse.org website is generated with Hugo.

Eclipse IoT provides the technology needed to build IoT Devices, Gateways, and Cloud Platforms.

Build Status

Getting started

Install dependencies, build website and start a simple webserver:

npm install && hugo server

Contributing

  1. Fork the EclipseFdn/iot.eclipse.org repository
  2. Clone repository: git clone https://github.com/[your_github_username]/iot.eclipse.org.git
  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
  6. Submit a pull request

Project Adopters

Does your organization use Eclipse IoT projects? Organizations — whether they are members of the Eclipse Foundation or not — can be listed as Eclipse IoT technology adopters.

Adopters are organizations that voluntarily show their support for the Eclipse IoT projects they have adopted (i.e. shipping commercial products based on the projects and/or using the projects for non-commercial or internal reasons). On this website, adopters are displayed under the /adopters virtual path.

You can add your organization logo to our list of adopters by submitting a pull request or by creating an issue. You can attach files to an issue by dragging and dropping them in the text editor of the form.

If you plan on submitting a pull request, you will need to make the following changes to the website's codebase:

  1. Add a colored and a white organization logo to static/assets/images/adoptors. We expect that all submitted logos to be transparent svg.
  2. Update the adopter data file: data/adopters.yml If your organization wishes to express support for multiple projects, you will need to add your organization's YAML definition to the adopters list of each of the relevant project nodes.

Javascript Plugin

Eclipse projects can showcase the logos of their adopters on their project websites. We built a JavaScript plugin to make this process easier. If you are a project committer, here are quick instructions on how to use the eclipsefdn-adopters.js on your Eclipse projet website:

Usage

Include the plugin's JS in the section of the page:

<script src="//iot.eclipse.org/assets/js/eclipsefdn.adopters.js"></script>

Load the plugin:

<script>
  eclipseFdnAdopters.getList({
    project_id: "[project_id]"
  });
</script>

Create an HTML element containing the chosen selector:

<div class="eclipsefdn-adopters"></div>
  • By default, the selector's value is eclipsefdn-adopters.

Options

<script>
  eclipseFdnAdopters.getList({
    project_id: "[project_id]",
    selector: ".eclipsefdn-adopters",
    ul_classes: "list-inline",
    logo_white: false
  });
</script>
Attribute Type Default Description
project_id String Required: Select adopters from a specific project ID.
selector String .eclipsefdn-adopters Define the selector that the plugin will insert adopters into.
ul_classes String Define classes that will be assigned to the ul element.
logo_white Boolean false Whether or not we use the white version of the logo.

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

Bugs and Feature Requests

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.

Maintainers

Christopher Guindon (Eclipse Foundation)

Eric Poirier (Eclipse Foundation)

Trademarks

  • Eclipse® is a Trademark of the Eclipse Foundation, Inc.

Copyright and license

Copyright 2018 the Eclipse Foundation, Inc. and the iot.eclipse.org o authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).