Skip to content

Organize and consolidate name & logo usage guidelines, 3rd-party branding guidelines #16

@tedepstein

Description

@tedepstein

This Style Guide now provides some guidelines for the use of the OpenAPI name in the branding of projects, tools, and organizations outside the OAI itself, and the use of logos resembling the OpenAPI logo in such projects.

However, I had a hard time finding guidelines for appropriate usage of the OpenAPI logo itself.

It turns out that the usage guidelines seem to be in three different places:

  • This OpenAPI Style Guide
    • Sourced from the README file
    • This is the only page that has the new 3rd-party branding guidelines.
  • The FAQ / Style Guide page on the OpenAPIs.org website.
    • That page looks like it might have been sourced from an earlier revision of this style guide.
    • I don't see a link from that page to this style guide project on GitHub, only to the logos. The page content includes a mention of "this repository," but the page appears outside of any repository.
  • The FAQ / FAQ page on the OpenAPIs.org website.
    • That page refers to (but doesn't actually link to) the Linux Foundation Trademark Usage page.
    • That page is the only one that contains requirements for trademark symbols and attribution notices, which may be important to mention in any context that describes appropriate usage.
    • That page is also the only one that describes general guidelines for appropriate use of the OpenAPI logo.
    • It also contains a guideline for third-party usage that is expressed somewhat differently from the naming guidelines in this Style Guide:

      Use is NOT acceptable if a company is stating, or implying, that OAS is a mark of an org besides the LF. For example, entities should ensure that their own product names and logos are larger than OAI/LF – OpenAPI Initiative and OpenAPI Specification should not be the most prominent name or logo on their materials.

There's quite a bit of overlap across these pages. There are likely some inconsistencies. They don't seem to be cross-linked in a methodical way. A person looking at any one of these pages probably won't know to look at the others to get the full picture. They would reasonably assume that the guidelines they see are complete and definitive.

I think we should look at this carefully and try to make it more DRY, so there's exactly one authoritative source for information about appropriate use of the OpenAPI names and logos, along with the related third-party branding guidelines.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions