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

Consolidate web presence names for better discovery #530

Closed
grokify opened this issue Jul 11, 2018 · 3 comments
Closed

Consolidate web presence names for better discovery #530

grokify opened this issue Jul 11, 2018 · 3 comments

Comments

@grokify
Copy link
Member

grokify commented Jul 11, 2018

Description

Right now, OpenAPI Tools and Generator have a number of different names for various web presences. If we can consolidate the names, it would make for better discovery and a more consistency for users. Some examples include:

Some questions include:

  • What is the top level entity we want to promote: OpenAPI Tools, or OpenAPI Generator? We have a GitHub org for Tools and a Twitter handle for Generator. We have web domains for both Generator and Tools.
  • Can we consolidate names and have a single name for the Tools and Generator entities, e.g. openapi-generator vs. oas_generator.
  • Can we consolidate the name styles. For example openapi-generator.tech and openapitools.org have different TLDs.

If we want to promote OpenAPI Tools, then we could have:

If we wanted to promote the OpenAPI Generator, we could have:

Either way, it would be nice to be consistent between the GitHub, Twitter and web presences.

@jmini
Copy link
Member

jmini commented Jul 11, 2018

Thank you a lot for this summary! It helps to start a discussion.

@jmini
Copy link
Member

jmini commented Jul 13, 2018

The OAI group (The "OpenAPI Initiative" group, responsible for the OpenAPI project) has raised some concerns about the name of our project and about the name of our organization. After our public launch, they have updated their guideline.
We are trying to understand the implications and have opened OAI/OpenAPI-Style-Guide#14 to discuss it.

Right now we are waiting for feedback.

Until we know more, we might need to put the consolidation action proposed in this issue on hold.

@jimschubert
Copy link
Member

Regarding the options…

GitHub: @OpenAPITools
GitHub: OpenAPITools/openapi-generator

We have these.

Twitter: twitter.com/OpenAPITools

Twitter apparently no longer lets you choose the twitter name?

Web: openapitools.org

We have this, it redirects to this repo currently but could/should redirect to organization details in the future.

Web: openapitools.org/openapi-generator

This isn't necessary. Most tools/framework have a dedicated site which is not resourced under a TLD. See, for example delta.io (DataBricks), swagger.io (SmartBear),

If we wanted to promote the OpenAPI Generator, we could have:

GitHub: OpenAPITools/openapi-generator

We have this

Twitter: twitter.com/openapi-generator

Again, we can't choose the name, apparently.

Web: openapi-generator.tech

We have this as a documentation site specific to the generator.


So, aside from Twitter being screwy, the openapitools.org/openapi-generator recommendation is debatable.

I hope you don't mind if I close this as I work on cleaning up outstanding issues? If you feel strongly that openapitools.org/openapi-generator should be an alias for openapi-generator.tech, please reach out on Slack and we can see how that might work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants