eclipsefdn-project-adopters

NOTE

This project was migrated to Eclipse Gitlab on May 9, 2022.

Getting started

Install dependencies, build website and start a simple webserver:

npm install && hugo server

Contributing

Fork the EclipseFdn/eclipsefdn-project-adopters repository
Clone repository: git clone https://github.com/[your_github_username]/eclipsefdn-project-adopters.git
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -m 'Add some feature' -s
Push feature branch: git push origin my-new-feature
Submit a pull request

Project Adopters

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

Adopters are organizations that voluntarily show their support for the Eclipse 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:

Add a colored and a white organization logo to static/assets/images/adopters. We expect that all submitted logos to be transparent svg and compressed for web. While SVGs are preferred, PNGs are also acceptable.
Update the adopter JSON file: config/adopters.json. Organizations can be easily marked as having multiple adopted projects across different working groups, no need to create separate entries for different projects or working groups!

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 project website:

Usage

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

<script src="//eclipsefdn-project-adopters/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		Select adopters from a specific project ID.
`working_group`	String		Select adopters from a specific working group 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.

list of working groups for param `working_group`

jakarta-ee
automotive
cloud-development-tools
internet-things-iot
locationtech
openmdm
polarsys
research
science
sparkplug
tangle-ee

Testing

After creating a pull request, please refer to "/test-new-adopters" on the preview link to check the new added adopters are correctly rendered.

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.

EclipseFdn/eclipsefdn-project-adopters