asyncapi / brand

AsyncAPI brand guidelines and strategy

Read the specification

The latest draft specification can be found at spec/asyncapi.md which tracks the latest commit to the master branch in this repository.

The human-readable markdown file is the source of truth for the specification.

• Version 3.0.0 (latest) (website)

Click to see reference links to older versions of the specification.

• Version 2.6.0
• Version 2.5.0
• Version 2.4.0
• Version 2.3.0
• Version 2.2.0
• Version 2.1.0
• Version 2.0.0
• Version 1.2.0 (deprecated)
• Version 1.1.0 (deprecated)
• Version 1.0.0 (deprecated)

Looking for the JSON Schema files? Check out our spec-json-schemas repo.

Feel like contributing? Check out our contributor's guide.

Examples

Check out the examples directory for examples.

Case Studies and Adopters

Check out the AsyncAPI website to see the list of AsyncAPI adopters and their use cases.

Our Sponsors

Want to become a sponsor? Learn what we do with sponsors' money and join the club.

Platinum

    

Gold

Silver

    
    

Bronze

Contributors

Thanks goes to these wonderful people (emoji key):

Fran Méndez 💬 🐛 📝 📖 🤔 🚇 🚧 👀 ✅ 📢	Lukasz Gornicki 📖 🤔 👀 💬 📝 📢 🚧 🚇	Mike Ralphson 💬 📖 🤔 🚇 👀 🚧	raisel melian 💬 🐛 📖 🤔 🚧 👀	Chris Wood 🤔 📖	Jonathan Schabowsky 📖 🤔	Victor Romero 🤔 👀	Antonio Garrote 🤔 👀 📖	Jonathan Stoikovitch 💡 🤔 👀
Jonas Lagoni 🐛 📖 🤔 💬 👀 💡	Waleed Ashraf 📢 🤔 📖 💡	Andrzej Jarzyna 📢	Emmelyn Wang 📝 🤔 📖 📢	Marc DiPasquale 📝 📢 👀 🐛 🤔 📹	Gerald Loeffler 📖 🐛 🤔	Dale Lane 📝 🤔 📹 📢 ✅ 📖	Maciej Urbańczyk 👀 🤔 💬 🐛 📖 💡 🚧	Vladimir Gorej 📖 🐛 💡 🤔 👀
Lorna Jane Mitchell 📢 🤔	Laurent Broudoux 📖 📝 📢 💡 🤔 👀	Jesse Menning 📝 📢 👀 🤔	Sergio Moya 👀 🤔 💬 📝 🐛 📖 💡 🚧	Alexander Balogh 📖 🐛	Khuda Dad Nomani 💡 🐛	Aaron Korver 📖	Orlov Valentine 📖	Moez Bouhlel 📖
Muhammad Rafly Andrianza 📖	Daniel Kocot 📖 💡 🤔	sekharbans-ebay 📖 💡 🤔	Michael Davis 🐛 📖 💡 🤔	Heiko Henning 🐛 💻 🖋 📖 💡 🤔 🚧 👀	Quetzalli 🖋 📖 💡 🤔 👀	Akshit Gupta 🖋 📖	samz 🐛 🖋 📖 💡 📆	Rishi 🚧 🚇
nickshoe 🐛 📖	Ace 📋 🤔 🚧 📢	Animesh Kumar 🖋 📖 🚧	Fabrizio Lazzaretti 📖	Pavel Bodiachevskii 📖 🐛 🤔 💬

This project follows the all-contributors specification. Contributions of any kind welcome!

brand's Issues

Access to Figma file

I thought if we have a brand/design system, why don't we have the link to the Figma file published for public access(read-only)? We can put it somewhere in the READme

cc @mcturco

Clearly specify the license of the project

as we keep here all different brand-related graphics we need to make sure it is clear how people can use them from a license perspective.

It is not that obvious for people that IP of the project belongs to Linux Foundation and probably whatever people want they can do with these graphics (as long as they follow guidelines)

• investigate what other LF projects use for license, creative commons or something else and create a proper license file in the repo
• add to readme a clear note, explanation if people can freely use the graphics and if they need to, maybe reference to asyncapi.com or stuff like that

Banners for AsyncAPI conference

Hey we need some banners for AsyncAPI Conf CfP form

Technical requirement:
• 1040x84 - this will be used for the landing page of the CFP portal
• 632x84 - this will be used for all other pages on the submission form

• for now we just need proper brand color and text AsyncAPI Conference 2022
• long term we can do something nicer with info about conference date

Design system: define foundation

In this issue, we will discuss what AsyncAPI needs the most out of a design system and what those building blocks look like.

The foundation of this design system should include the smaller pieces:

• Color
• Typography
• Spacing
• Grid Systems

I am thinking this particular design system will be mostly focused towards the AsyncAPI React Component as other things like the website and marketing materials will fall under their own systems (those are not in high priority at this time).

Once we define the base structure, we can begin to iterate on design patterns, starting at a smaller scale. Some examples of smaller design patterns might include the following:

• Buttons
• Links
• Inputs
• Dropdowns
• Lists

And the list can go on from there. I am thinking once we have a solid foundation, we can move into creating a UI kit that represents the spec.

Brand Refresh: Logo/Colors/Typography

I am proposing that we improve the AsyncAPI brand to better fit the trends of the industry as well as to establish a boilerplate for a design system (I will create a separate repo for this once we are in a good place with the brand) and eventually a UI kit. The brand refresh is the first step in the process of creating a brand structure for expected growth in the future.

In this issue, I will be working on the following:

• Small adjustments to the logo
• Redefining the color palette of AsyncAPI
• Typography
• Establish tone

Please note: These changes are intended to be subtle so as not to affect current brand recognition.

I will document my process in this issue and will be looking for feedback from those who are interested in being part of the process! :)

File names of AsyncAPI main logos are mixed up

Reason/Context
In the logos directory where the AsyncAPI logos can be downloaded, the file names are mixed up between the light and dark versions. Currently, the light version of logo is named as dark and the dark version as light

Thanks to @Harish-b-13 for catching this! 👏

Create README file

@alequetzalli mentioned that it would be great to include a README file in this repo so that we can better introduce the repo's purpose to the community & provide instructions on how to contribute. Any ideas for the structure of this file are welcome!

Brand Refresh: Iconography

This issue will be specifically geared towards defining a set of icons for use across AsyncAPI.

Brand Refresh: Voice & Tone

In this issue, we will work on establishing the voice and tone of the AsyncAPI brand.

GSoD mentees swag idea

Contribution Ask: GSoD 2022 swag 😬✌🏽

Missy designed some neat mentee swag for the AsyncAPI 2022 Mentorship program. Because GSoD mentees should also receive AsyncAPI swag, I was hoping we could ask for a design contribution for the GSoD mentees' swag.

Timeline ✨

If approved, whenever? 😄😂

Delivery process

To be handled separately from design; it will be a follow-up item with @Barbanio after/if/when design approves taking up this task

Add brand mark to logo kit

Reason/Context

Need to add brand mark alone without "AsyncAPI" logotype to the logos folder.

Description

• Add all logo versions in different file types
• Add some guidelines around using the brand mark alone

New repo banner request for Java Spring Template

Hello

Could you please make a repo banner for the Java Spring Template ?

Brand Refresh: Brand guidelines

Missy to create and establish a digital guide for logo usage and typography as well as brand colors and general dos and don'ts. This will be started once the Brand refresh issue is completed.

Need for urgent changes in GitHub Actions automation

This issue defines a list of tasks that need to be performed in this repo to make sure it's ci/cd automation works long term without any issues.

It is up to maintainers to decide if it must be addressed in one or multiple PRs.

Below are 3 different sections describing 3 different important ci/cd changes.

IMPORTANT-START
For GitHub workflows that contain This workflow is centrally managed in https://github.com/asyncapi/.github/ you do not have to perform any work. These workflows were already updated through the update in .github. The only exception is the workflows related to nodejs release. More details in Upgrade Release pipeline - in case of nodejs projects section
IMPORTANT-END

Deprecation of way data is shared between steps

Every single GitHub Action workflow that has echo "::set-output name={name}::{value}" need to be updated to follow echo "{name}={value}" >> $GITHUB_OUTPUT

We do not yet know when set-output will stop working. Previous disable date was 31.05 but now then say community needs more time.

For more details read official article from GitHub

Deprecation of node12

2nd bullet point is still relevant for you even if your projects in not nodejs project

• Every single workflow that uses setup-node action needs an update to follow v3 version of this action, and make sure minimum node 14 is used
• Now this part is more complex. Problem with node12 is that node-based GitHub Actions were using it in majority as a runtime environment. Look for example at this action.yaml file for setup-node action v2. So the job that you have to do is go through all the workflows, and verify every single action that you use, make sure you are using the latest version that is not based on node12. I already did review a lot of actions as part of this PR so maybe you will find some actions there and can copy from me. For example action/checkout needs to be updated to v3.

Node12 end of support in action is probably September 27th.

For more details read official article from GitHub

Upgrade Release pipeline - in case of nodejs projects

ignore this section if your project is not nodejs project

You have 2 options. You can:

A. choose to switch to new release pipeline using instruction from asyncapi/.github#205

B. stay with old release pipeline, and manually update GitHub workflows and actions used in it, you can inspire a lot from this PR asyncapi/.github#226

I definitely recommend going with A

Workflows related to release:

• .github/workflows/if-nodejs-release.yml
• .github/workflows/if-nodejs-version-bump.yml
• .github/workflows/bump.yml

Brand Refresh: Mascot

In this issue, we will discuss concepts for an AsyncAPI mascot.

Currently, we have Eve & Chan (their names represent events and channels)

I think while the concept of them is cool, I feel that we need to simplify their illustrative details and perhaps create characters out of basic shapes (they will feel more like a flat graphical drawing with few curves and minimal shading/coloring)

---

References:
The following references are to give us inspiration based on art style, not the actual character that is shown. We can use these drawings for inspiration to build the new look of Eve & Chan.

Reference 1: I enjoy the simple shapes and curves that this character has and the color palette is simple and adaptable for use in new environments.

Reference 2: Again, very simple shapes, colors, and facial expressions

Reference 3: These remind me a lot of Postman's "postmanaut", but I think we could potentially draw inspiration here from the body shape and translate that style to Eve & Chan fairly easily

Update README with new logo banner

Reason/Context

This is to replace the old AsyncAPI logo in this repo's README with the banner attached below that represents the new branding.

Here are a few guidelines for this change as well:

1. Make sure you are using Markdown syntax only
2. Be sure to remove the old logo as well as the old title of the repo as this image will replace both elements
3. Make sure you link this image to the website: https://www.asyncapi.com
4. If there is any description text below the repo title, let's make it left-aligned if it isn't already, so as to match the left-alignment of the content in the new banner image

Download the image file:
github-repobanner-brand.png.zip

---

Banner preview

Please note that this is only a preview of the image, the contributor should download and use the above zip file

Design brand guidelines

Reason/Context

Creating a mockup to add the new Brand Guidelines to the website in a separate documentation area.

Figma file of current progress --> https://www.figma.com/file/yLZsxymcotx0mUwy5Pc7xB/?node-id=213%3A362

Update presentation deck/template with new branding

Reason/Context

requested by @derberg

We need to update the AsyncAPI Deck to match the new visual style.

Question for @derberg: Just so I am fully understanding this request, should I update this whole presentation with the content that is there, or should I create a presentation template with the new branding? Or both? 😄

[📑 Docs]: Select color hex codes for Docs UML diagrams

What Dev Docs changes are you proposing?

AsyncAPI brand-compliant colors for UML Diagrams in Docs

Now that the community has voted on which diagram tool to use, it is time for design contributors to guide us in handling colors in new UML diagrams about to be added to our Docs.

We need design contributors to provide feedback on which color hex codes and what % shades of each color to use.

Color system proposed

I would like to propose we follow the industry-standard UML coloring system first suggested by Peter Coad, Eric Lefebvre, and Jeff De Luca in their series of articles in The Coad Letter,[1][2] and later published in their book Java Modeling In Color With UML.[3]

Object Modeling in Color [4]

• 💓 pink (moment-interval) — Examples in business systems generally model activities involving people, places and things such as a sale, an order, a rental, employment, making a journey, etc.
• 💛 yellow (roles) — A person, place, or thing can play a role in an activity. Examples could be a person playing the role of an employee in employment, a thing playing the role of a product in a sale, or a location playing the role of a classroom for a training course.
• 💙 blue (description) — A catalog-entry-like description that 'labels' an object. For example, a car's make and model categorize or describe a number of physical vehicles.
• 💚 green (party, place, or thing) — The role-players in a system. People are green. Organizations are green. Physical objects such as a tablet, are green things.

Here's an example showcasing how to apply the UML color standard that comprises of four colors [5]:

UML Learning Resources

• Intro to UML Diagrams
• Colors in object modeling
• UML Class Diagramming tutorial
• Behavioral UML diagram and Structural UML diagram

---

cc'ing the people

• GSoD contributors: @Annysah, @thulieblack, @Florence-Njeri, @starlightknown, @nelsonmic, @pratik2315
• Mentors & Community: @derberg, @smoya, @fmvilas, @magicmatatjahu
• Design contributors: @mcturco, @dattavelivela

Code of Conduct

• I agree to follow this project's Code of Conduct

some additional graphics for AsyncAPI Conference 🙏🏼

@mcturco we need some more graphics for AsyncAPI Conference:

Email & SSO Image: 1000 x 200 (JPG/PNG)
An image containing event name, event location, and event dates
"AsyncAPI Conference - Virtual - November 3-5 2022" 

Header Image: 1920 x 500 (JPG/PNG)
A background-only image that allows for Cvent text to be added over it.

There are all for the event registration platform.

Create a banner for AsyncAPI Mentorship Program

@mcturco, as we discussed in slack.

We have started our AsyncAPI Mentorship Program 2022. Only thing that we are missing is having a banner, that one can showcase in the socials.

Brand Refresh: Tooling Branding

In this issue, we will discuss the brand identity of AsyncAPI online tools.

(This might be subject to change depending on the feedback of the new logo and color palette)

New repo banner request for EDAVisualizer

Title: EDAVisualiser
Link: https://github.com/asyncapi/EDAVisualiser

Would love to get some marketing materials for `Let's talk about contributing` live stream

Reason/Context

As part of the efforts to make it easier for people to contribute to the project, we are running regular live stream sessions about it.
It would be nice to create some marketing materials that we could easily reuse for the sessions.

Playlist for more context: https://www.youtube.com/playlist?list=PLbi1gRlP7pigPBrBMaNQhUeniR1pdDMiY

We are not in rush here. This is why I mark it as a good first issue in case there is someone in the community that would like to join AsyncAPI as a contributor to such cool things that are not just code.

Description

We would need something like a speaker card, that you usually have for conferences, that contains the live stream name, topic/title, date of meeting, and place for info about host and guest (including avatars)

It would be used to promote event on social media before it happens, and also as a video thumbnail afterwards.

Maybe there are also some other material that can be produces, dunno 🤷🏼 opened for any suggestions

Add generic github repo banner asset

Reason/Context

I think we should include in this repo somewhere the generic repo banner asset so others can download it and use it in other org repos.

Here is the asset: