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

Update README with new logo banner #290

Closed
mcturco opened this issue Mar 11, 2022 · 13 comments · Fixed by #296
Closed

Update README with new logo banner #290

mcturco opened this issue Mar 11, 2022 · 13 comments · Fixed by #296
Labels
area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. enhancement New feature or request good first issue Good for newcomers released

Comments

@mcturco
Copy link
Member

mcturco commented Mar 11, 2022

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://studio.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-studio.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

github-repobanner-studio

@mcturco mcturco added enhancement New feature or request good first issue Good for newcomers area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Mar 11, 2022
@fmvilas
Copy link
Member

fmvilas commented Mar 11, 2022

Doesn't Studio have its own logo? 🤔 May be worth putting it here instead of this banner?

@mcturco
Copy link
Member Author

mcturco commented Mar 11, 2022

@fmvilas I was wondering the same thing but wasn't sure... Yeah I guess now that you bring it up, it would be fine since the asyncapi mark is still in the studio logo.

Do we like something like this? Let me know if we should change the description (cc @magicmatatjahu)

github-repobanner-studiov2

@magicmatatjahu
Copy link
Member

magicmatatjahu commented Mar 11, 2022

@fmvilas @mcturco

In the description of the repository we have:

Visually design your AsyncAPI files and event-driven architecture.

We don't only visualize AsyncAPI, but also do other things (that's why we talk also about design of EDA). But maybe Fran has another (better) suggestion for the description.

@mcturco
Copy link
Member Author

mcturco commented Mar 14, 2022

@magicmatatjahu Sounds good! I have updated the text to your suggestion and also provided an alternate layout. But of course, if we have a better description suggestion I can update it, no problem.

I think Option 2 is more impactful for the Studio, but it will require more scrolling for the user (something that might not be a huge deal for GH README?)

Option 1
github-repobanner-studiov3

Option 2
github-repobanner-studiov4

@magicmatatjahu
Copy link
Member

@mcturco Awesome, thanks! I prefer that 1 option and you described why:

I think Option 2 is more impactful for the Studio, but it will require more scrolling for the user.

😄 @fmvilas What do you think?

@fmvilas
Copy link
Member

fmvilas commented Mar 15, 2022

I actually like the second option better 😄 I don't care to scroll tbh.

@mcturco
Copy link
Member Author

mcturco commented Mar 15, 2022

I actually like the second option better 😄 I don't care to scroll tbh.

Yeah I think I like the layout of the second option better. It is better visual hierarchy. I think for a Readme file its not that big of a deal to scroll a bit more, and this option isn't that much taller. It's similar to the one we have on the org Readme, and I think that one works well.

@magicmatatjahu
Copy link
Member

We can go with the second option.

@mcturco
Copy link
Member Author

mcturco commented Mar 16, 2022

Great! I have updated the assets in the issue comment at the top, so this issue is ready for a PR 😄

@magicmatatjahu
Copy link
Member

@mcturco I also noticed that we should change the photo in the og metadata. Currently the old logo is still there.

image

@mcturco
Copy link
Member Author

mcturco commented Mar 16, 2022

@magicmatatjahu good call! Do you want to open up a separate issue for that?

@magicmatatjahu
Copy link
Member

@mcturco #295 :)

@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 0.11.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

KhudaDad414 pushed a commit to KhudaDad414/studio that referenced this issue Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. enhancement New feature or request good first issue Good for newcomers released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants