Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an 'adopters' page #1565

Closed
smlambert opened this issue Mar 2, 2023 · 17 comments · Fixed by #1644
Closed

Create an 'adopters' page #1565

smlambert opened this issue Mar 2, 2023 · 17 comments · Fixed by #1644
Assignees
Labels
enhancement New feature or request

Comments

@smlambert
Copy link
Contributor

smlambert commented Mar 2, 2023

Mentioned in #1253, we would like to create a page where we gather testimonials and logos from a broad range of our adopters (in similar fashion to https://ecdtools.eclipse.org/adopters/ or https://iot.eclipse.org/adopters/). We used to host a similar users page in a past life, mentioned here).

Why companies who use Eclipse Temurin binaries may want to add their logos to our Adopters page?

  • Helps us understand who is using our binaries, their use case and needs (which may help us serve them better)
  • Shows other potential consumers where are binaries are being used and bolster their confidence in moving to use our offering, encourage others to try our binaries
  • A low-effort direct and easy way for companies to help support us. It does not require any $$ from them, but definitely a boost to the teams working at the project to know who is using and how the binaries are deployed.

Describe the solution you'd like

  • Ensure that we are following the Eclipse Foundation guidelines for gathering logos, company information and quotations (by looking at the ecdtools and iot examples).
  • Create a draft page populated with real and/or fictitious data, to socialize with members and solicit participation
  • Gather enough participation and adopter examples, and then launch the new page (keep it in draft until an initial list is populated).

Additional context
Add any other context or screenshots about the feature request here.
https://ecdtools.eclipse.org/adopters/ and https://ecdtools.eclipse.org/adopters/get-listed/
https://iot.eclipse.org/adopters/ and https://iot.eclipse.org/adopters/how-to-be-listed-as-an-adopter/

We should put extra care into making this a seamless process for our adopters (the less steps and hassle, the better).

@smlambert smlambert added the enhancement New feature or request label Mar 2, 2023
@CarmenDelgadoEclipse
Copy link

CarmenDelgadoEclipse commented Mar 2, 2023

I am asking Eclipse Webdev team about this.

cc: @chrisguindon

@smlambert
Copy link
Contributor Author

Thanks Carmen. We likely need to request that adoptium is added to the working_group attribute mentioned here.


For the 2 paths described from the iot and ecdtools examples, both appear to require the potential adopter to have an Eclipse account. Neither path offers a self-serve way for adopters to include a testimonial.

Path 1: Raise an issue at:
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues/new

Path 2: Create a PR at:
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/

We can offer a self-serve model, but smooth out the experience for potential adopters, and additionally, request the optional testimonial field. Perhaps we have a 3rd path (a shim layer, that let's us ask for the optional testimonial and absolves our adopters from needing to create an Eclipse account or a PR).

[Proposed] Path 3:
Allow adopters to create the adopter request on our website or in this publicly reachable repository. Request the 4 pieces of information: org name, org website, logo, optional 'testimonial'. Automatically create a PR for their request, to https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters.

Information needed by Eclipse Foundation (pulled from the gitlab issue template):

---
name: Project Adopter Request
about: List your organization logo as an adopter of an Eclipse project.
---

Project Name = "Eclipse xxxxxx"

## Information about your Organization
* Name:
* Website: 

### Logos

**Important:** Please attach your logos in svg or png format, zipped if svg. Please note that we require both color options for logos for distribution purposes.

* We need color logo with transparent background.
* We also need white logo with a transparent background.

Looks like once the EF adopters repository is updated, it can be embedded on our website via
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters#javascript-plugin

@CarmenDelgadoEclipse
Copy link

CarmenDelgadoEclipse commented Mar 3, 2023

How-to from @chrisguindon
EF provides a standalone JavaScript Plugin that Project and Working Group websites can use to display adopter logos: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/blob/main/README.md#javascript-plugin
An example is the Eclipse Hono website with their WHO IS USING ECLIPSE HONO? section : https://www.eclipse.org/hono/

The second use case, which I believe is the one you are interested in, are WGs that wish to display the logo of adopters from projects that the WG is interested in.
Then you need to find adopters to submit their logos to our service. That's also documented in our README file:
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/blob/main/README.md
We provide instructions for those who wants to submit an MR. It's also possible to make a request via issues but process usually takes a bit more time since we need to do most of the work:
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues/new?issuable_template=adopter_request.md
It's also worth mentioning that requests for adding a logo must originate from employees of the organization.
Staff can't make a request on behalf of another org. We use this process as a way to ensure compliance with their logo guidelines and as a way to have permission to use their logo since it's was provided by them.
This process allows our websites to display logos from non-eclipse member without having to "distribute" them in a public git repo for the website source code.

What is required for the WG website?

About testimonials:
The spec to our API is public:
https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/blob/main/spec/openapi.yaml?plain=1
Instead of using our standalone solution, they can fetch the data from our API and include testimonials

@gdams
Copy link
Member

gdams commented Mar 9, 2023

More than happy to help with the implementation of this

@tellison
Copy link
Contributor

@CarmenDelgadoEclipse we won't need help from the Eclipse web dev team to create a testimonials page for Adoptium, since we manage our own website dev and are able to integrate such a feature into the existing technology seamlessly.

So at this point we are waiting on the EF marketing folks to provide some words, attributions, and logos that we can use.

p.s. Courtesy of gdams, here's a link to the testimonials page we had for AdoptOpenJDK that we didn't bring across to Eclipse (to ensure that we start with the required approvals for Adoptium usage).

@CarmenDelgadoEclipse
Copy link

@CarmenDelgadoEclipse we won't need help from the Eclipse web dev team to create a testimonials page for Adoptium, since we manage our own website dev and are able to integrate such a feature into the existing technology seamlessly.

So at this point we are waiting on the EF marketing folks to provide some words, attributions, and logos that we can use.

p.s. Courtesy of gdams, here's a link to the testimonials page we had for AdoptOpenJDK that we didn't bring across to Eclipse (to ensure that we start with the required approvals for Adoptium usage).

@tellison We agreed with the marketing team to first a "draft" project and how-to to prepare the campaign with the possible first adopters. That is why the first step was confirming the tech steps with Webdev team.

@CarmenDelgadoEclipse
Copy link

CarmenDelgadoEclipse commented Mar 23, 2023

Some notes after today's Marketing committee:

  • - Have a mock-up (Draft) to promote internally. Mar 30, 2023 @gdams
  • - Put the issues in the GitHub project @gdams -
  • - Have a How to submit a logo. (Show some logos, at least current members and sponsors) Apr 12, 2023
  • - Add Testimonials as part of the submission, diff process and independent from the logo submission. Confirm with Eclipse Operational team the new how-to proposal.
  • - Individual invitations to those we know use Temurin.
  • - Define the communication campaign. EF Team (Blog, newsletters, Eclipse.org as a banner, email campaign (8.000 names) and social media campaign)
  • - Go live with some adopters first from Adoptium and Eclipse Foundation. Apr, 30

@CarmenDelgadoEclipse
Copy link

CarmenDelgadoEclipse commented Apr 13, 2023

Pending the how-to for the submission process: Add a checkbox for multiple selections of why they are using Temurin and a small testimonial, and if they want to share it publicly or not (GDPR) (writing @smlambert suggestion :))

@CarmenDelgadoEclipse
Copy link

Hello more information for the how-to page, We do need to make sure to include acceptable logo format information, similar to the text here: https://ecdtools.eclipse.org/adopters/get-listed/

@CarmenDelgadoEclipse
Copy link

@chrisguindon In the meantime, George updates the design comments.
Can you help us get the API available to submit the logos?.
@gdams to confirm If I'm saying the right words. :)

@gdams
Copy link
Member

gdams commented May 12, 2023

yeah that's all good, essentially we should be ready to open up the API

@CarmenDelgadoEclipse
Copy link

yeah that's all good, essentially we should be ready to open up the API

@gdams did you have the chance to review these comments:
#1644 (comment)
and
#1644 (comment)

@CarmenDelgadoEclipse
Copy link

@gdams to properly request the API needed for the Adopter page (specifying what the Adoptium's Adopter page needs), @chrisguindon suggested creating an issue on this board https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues.
Please add me as a cc when creating the new request to follow the issue.

@chrisguindon
Copy link

chrisguindon commented May 17, 2023

It's not very clear to me what's needed from Adopitum. From what I can tell from this issue, the request was mostly discussed in a meeting. I don't have enough details to provide guidance but I am going to try based on what I think is being requested...

If I am assuming correctly, Adoptium would like to request that we create a new endpoint for our Adopters API to enable users to upload images. If this is correct, I am not convinced this is something we can easily do.

Background: The main reason we ask people to use Gitlab to submit their logo is that we want a public record that the logo was provided by an employee of the organization or someone acting on behalf of that organization to ensure that they give us permission to use it in our project. We don't allow unaffiliated users to upload logos that they don't own.

Also, by creating an issue or an MR, enables us to review and test the new images before it's deployed. If a new proposal is made, we need to ensure that we can still do all of these things.

With that said, The community can request new features by creating an issue against the eclipsefdn-project-adopters project: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues.

Please provide as much information as you can. We will be able to discuss the request further via that new issue.

@chrisguindon
Copy link

chrisguindon commented May 17, 2023

Also, just to set expectations: This is not a project we can prioritize in the short term. I would recommend that we focus on moving this forward without this API feature request as a blocker.

I would recommend including a direct link to our Project Adopter Request template on the Adoptium website: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/issues/new?issuable_template=adopter_request

@chrisguindon
Copy link

chrisguindon commented May 17, 2023

I just spoke with @gdams on Slack and my assumptions were incorrect. There is no need for any new requests, the Adoptium WG needs us to confirm how the existing API works. Here's my answer to that question:

There are 2 things to consider for this to work.

  1. We need to add logos to this file: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/blob/main/config/adopters.json. We also need to ensure that new or existing logos have Adoptium projects listed. An organization/adopter can adopt 1 or many Eclipse Projects.
  2. we need to ensure that Projects that are of interest to Adoptium are properly tagged as such. You can verify that via our project API: https://projects.eclipse.org/api/projects

For example, let's look up Eclipse AQAvit™ https://projects.eclipse.org/api/projects/adoptium.aqavit.json
We can see that this project is tagged for Adoptium:

"working_groups": [
  {
    "name": "Adoptium",
    "id": "adoptium"
  }
],

To summarize, if an organization adds a logo and adoptium.aqavit is listed in the project array in https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-project-adopters/-/blob/main/config/adopters.json, then we should see that logo when making a request to https://api.eclipse.org/adopters/projects?working_group=adoptium

@CarmenDelgadoEclipse
Copy link

CarmenDelgadoEclipse commented May 18, 2023

Hello, after today's marketing meeting, some pending tasks update:

New Due date: The first week of June

@gdams gdams linked a pull request May 26, 2023 that will close this issue
4 tasks
@smlambert smlambert removed their assignment Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants