search

eclipse-archived / codewind

The official repository of the Eclipse Codewind project
https://codewind.dev
Eclipse Public License 2.0
113 stars 45 forks source link

Update plugin names for Open API Tools #3232

Open AndyRWatson opened 3 years ago

AndyRWatson commented 3 years ago

Codewind version: OS:

Che version: IDE extension version: IDE version: Kubernetes cluster:

Description:

Following email correspondance with eclipse focundation, The naming of the OpenAPI tools does not meet Eclipse Foundation Guidelines 

Codewind is a trademark of the Eclipse Foundation. As such, it subject to the terms of the Eclipse Foundation Trademark Usage Guidelines.

Trademark management is mostly about avoiding confusion. In that regard, you cannot call a product "Codewind Foo" as this very tightly associates the brand with your product. Rather, you may use the form "Foo for Codewind". So, "Codewind OpenAPI Tools" is not acceptable, but "OpenAPI Tools for Codewind" is (or, more ideally, OpenAPI Tools for Eclipse Codewind").

You can use the Codewind logo, but you may not modify it or incorporate it into a product's logo.

You must also attribute the trademarks to the Eclipse Foundation by adding a statement along the lines of "Codewind and the Codewind logo are trademarks of the Eclipse Foundation".

We should look to update the OpenAPI tools in the marketplace to

In addition it would also make it easier to identify the plugin as official by

ref https://github.com/eclipse/codewind-openapi-vscode
https://github.com/eclipse/codewind-openapi-eclipse

MelHopper commented 3 years ago

Is it possible, whilst updating the OpenAPI references in the content as part of this defect, to also fix the following small-change defect in the install instructions, described below? This applies to all the files that need updating with the new OpenAPI product name:

https://github.com/eclipse/codewind-openapi-eclipse https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools https://www.eclipse.org/codewind/open-api-tools-for-vscode.html https://www.eclipse.org/codewind/open-api-tools-for-eclipse.html https://github.com/eclipse/codewind-openapi-vscode

The installation instructions are confusing in terms of how the OpenAPI tools extension is installed - see screenshot. In particular, step (3) refers to 'this', implying the 'optional' VS Code extension from step (2), but (3) is written as a separate step rather than a substep of (2). In addition, is step (4) only required if you have NOT actioned the optional step (2) (and (3)?

Screenshot 2020-09-28 at 15 26 10
waynebeaton commented 3 years ago

Note that if this is the product of the Eclipse project (i.e. it doesn't contain any extra intellectual property developed outside of the scope of the open source project), then you can (and should) call it "Eclipse Codewind OpenAPI Tools".

Trademark management is all about avoiding confusion. As long as Eclipse content is associated with the Eclipse trademark, we're good-to-go.

We still need the trademark attribution statement, please.

AndyRWatson commented 3 years ago

Thanks for the clarification @waynebeaton , I guess there has been some confusion here when the plugins are infact 100% part of the eclipse foundation project and not 3rd party enhancement. We should ensure the plugins have Eclipse Codewind at the start of the name along with the TM attribution you require.

AndyRWatson commented 3 years ago

@waynebeaton would you be happy with "Eclipse Codewind tool for OpenAPI" or maybe "Eclipse Codewind extension for OpenAPI". through our discussion we also realise we need to attribute the OpenAPI trademark as well . The tool extends Codewind IDE to be able to call out to an OpenAPI generator from within the IDE.

waynebeaton commented 3 years ago

Both sound fine to me. Please do note, however, that I am unfamiliar with the OpenAPI trademark usage guidelines (in my experience, the "... for xyz" is a commonly permitted pattern).

sishida commented 3 years ago

Based on this comment, https://github.com/eclipse/codewind/issues/3232#issuecomment-706220177, I have made this PR: https://github.com/eclipse/codewind-docs/pull/715

sishida commented 3 years ago

Updated website with "TM" and new name: https://www.eclipse.org/codewind/