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

Add twitter section on the Async API website #562

Closed
ritik307 opened this issue Jan 21, 2022 · 34 comments · Fixed by #749
Closed

Add twitter section on the Async API website #562

ritik307 opened this issue Jan 21, 2022 · 34 comments · Fixed by #749

Comments

@ritik307
Copy link
Contributor

Reason/Context

Please try answering few of those questions

  • Why we need this improvement?
    To let our users check our latest releases and updates directly from the website
  • How will this change help?
    Provide better user experience
  • What is the motivation?

Description

Please try answering a few of those questions

  • What changes have to be introduced?
    A new section on the Async API homepage.
  • Will this be a breaking change?
    Most changes are restricted to the homepage. If broken it will be mostly this page.
  • How could it be implemented/designed?
  • We can implement it via using react-twitter-embed npm package.
@github-actions
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@ritik307
Copy link
Contributor Author

@derberg What are your views on this? Should I implement this?

@magicmatatjahu
Copy link
Member

magicmatatjahu commented Jan 21, 2022

I love that idea! :) We can further expand this task (in one PR, or by followups) by adding a so-called "newsroom" section, which would consist of the latest blog posts (currently implemented), articles in another pages (cc @Barbanio), the latest tweets and the latest recordings on YT. What do you think about it?

@Barbanio
Copy link
Contributor

I really like the idea, and I love @magicmatatjahu's suggestion. I think that way all the information about it would be organized and localized.

@derberg
Copy link
Member

derberg commented Jan 21, 2022

I like the concept of newsroom a lot! like a 3 column view from blog/twitter/youtube

cc @mcturco @fmvilas

@mcturco
Copy link
Member

mcturco commented Jan 21, 2022

I agree and think that transforming the blog section to a newsroom section would be a good move! However, I am worried that if we do this it will seem quite bulky at the end of the homepage. Perhaps we can show most recent news in this section and then create a new Newsroom page where people can search through the archives of releases, live streams, etc. We can then add a call to action in other places on the website and maybe a navigation item in the header so this content is easier to access.

What do you think? @derberg @magicmatatjahu @Barbanio @fmvilas

@ritik307
Copy link
Contributor Author

ritik307 commented Jan 21, 2022

@mcturco @derberg @magicmatatjahu @Barbanio @fmvilas Glad you guys like the idea 😁. If possible can you guys provide mockups so I can start working on it?

@derberg
Copy link
Member

derberg commented Jan 21, 2022

new newsroom view, with short preview on landing page sounds good to me, we will be able to place there much more things, even "current" livestreams.

@akshatnema
Copy link
Member

This issue looks quite silent to me 🤔 😄. Although, the idea of newsroom is brilliant on the website. On the other side, it is quite a lengthy and time-taken process as well to first design and implement the whole page. I am quite interested in making the design and implementing this on the website.

@magicmatatjahu @mcturco is anyone working on this issue right now? I'm not seeing anyone here. I do have some designs to show up for this page. What's your take?

@mcturco
Copy link
Member

mcturco commented Feb 28, 2022

@akshatnema Go for it! Just be sure in your design mock up that you are referencing the current website design (you may even want to reference the styles made in this PR since the website style is about to drastically change) that way we are reusing as many existing components as possible, but also don't be afraid to introduce new layouts/ideas in conjunction. You may even choose to start implementing the new design straight in the code (maybe mock up is a waste of time, up to you) just make sure if you do this that you coordinate with @ritik307 since they were initially interested in working on this issue.

Let me know if you have any questions! 😄

@magicmatatjahu
Copy link
Member

I'm all for what Missy wrote :)

@akshatnema
Copy link
Member

akshatnema commented Feb 28, 2022

Let me know if you have any questions! 😄

@mcturco Yeah, I do have some. I will like to know what are the exact sections needed to show up in the newsroom. I'm planning to make a separate page for newsroom. Based on the discussion that happened before in this chat, I listed down the following things to be shown on this page:

  • Latest blogs
  • Latest Youtube streams
  • Latest tweets from Twitter
  • Any recent releases, news

Is anything else needed in this section that I forgot to mention? Or something that I added more than it is needed 😄? Do clear me out about these sections so that I can start making designs according to them.

@magicmatatjahu
Copy link
Member

@akshatnema I think that we don't need the new /newsroom page but only a new section in the main page (we can rid of Latest blog posts section and change it to the new one). I agree that we need all things that you mentioned, however for

Any recent releases, news

I think that you should try to create some YAML or JSON where people will pass new news by PR, something like we render blog posts, based on md, but in this case will one JSON/YAML as list of links to news/articles :)

@ritik307
Copy link
Contributor Author

@akshatnema I would like to join you on this issue. It would be great if we could split the work out, it will be faster that way. 🙂

@akshatnema
Copy link
Member

@akshatnema I think that we don't need the new /newsroom page but only a new section in the main page (we can rid of Latest blog posts section and change it to the new one). I agree that we need all things that you mentioned, however for

Thank You very much 🙌 @magicmatatjahu for saving me from another confusion. I recently got out from one such in my other PR 😄. Fine, then making my job quite easy, the design is quite easy to implement. I will get back to Missy by making one such design to get a review from her.

@akshatnema I would like to join you on this issue. It would be great if we could split the work out, it will be faster that way. 🙂

Thanks, @ritik307 for joining in. So now, let's collaborate and make it something amazing on the website 🚀. What I am planning is to use Twitter and Youtube APIs to render recent data on the website. This will automate these sections and we don't have to make it manually. @magicmatatjahu, I recently saw that we do need Google OAuth for Youtube API as well, so looks like we do have to discuss the variables (as mentioned in PR #609) for further implementation on this issue.

Regarding news, releases and recent blogs, yeah we do have to make a JSON file to implement it, where the recent news and other related information can easily be updated using PR.

@magicmatatjahu
Copy link
Member

@akshatnema About envs, I wrote comment how we should handle that :) #609 (comment)

@akshatnema
Copy link
Member

akshatnema commented Mar 1, 2022

@magicmatatjahu @ritik307 @mcturco Here's the link to my Figma design - https://www.figma.com/file/Xqluwz9HIZWLVBIGpwio7W/AsyncAPI?node-id=0%3A1
Consider only the leftmost design of the page for review.

It may seem to you that the design is going a bit wide or made for a seperate page, but honestly, I tried my best to fit all the things in a single section only and didn't look much ugly at the same time. I'm looking for the suggestions from your side 🙂.

@ritik307
Copy link
Contributor Author

ritik307 commented Mar 2, 2022

@akshatnema The design looks good but the colour theme is off as per the theme used by the official async API website. Can you kindly look into that? 😊

@akshatnema
Copy link
Member

akshatnema commented Mar 2, 2022

@akshatnema The design looks good but the colour theme is off as per the theme used by the official async API website. Can you kindly look into that? 😊

@ritik307 If you see PR #534, made by @mcturco, she is going to change the theme and styling of the website very soon. So, I have made the section according to the latest theme.

Also, I messaged you in Slack regarding this. Kindly do check there as well.

@magicmatatjahu
Copy link
Member

@akshatnema It looks awesome 🚀 however:

  • I think that Twitter is more important than YT so I would like to move twitter section with news on the center and YT on the right.
  • Is there an API in YT to checking live streams? I think that it would be awesome if we will show current live stream as first video in the YT section and then two latest videos deployed to our YT account. If there is nothing live then the last three videos.

WDYT?

@akshatnema
Copy link
Member

I think that Twitter is more important than YT so I would like to move twitter section with news on the center and YT on the right.

@magicmatatjahu I should say you are right in the motive you want to show, but let me tell you a brief on how Twitter embed will look. Do check out this link - https://developer.twitter.com/en/docs/twitter-for-websites/timelines/overview. If you see, if we make that twitter section in middle, the text size inside the embed (where we have no control) will become very much larger than the outside text size on the website. It may not look good for it. I analyzed the size of the embed and the properties it will show, I found that place perfect and of correct dimension for the embed. Coming to the Youtube section, I think we have to show the thumbnail and title of the video in correct dimensions so that it becomes readable to everyone. So, I found the middle section appropriate for it. But if you think, we should give more influence to Twitter, then I will change the design a little bit, making it to center.

Is there an API in YT to checking live streams? I think that it would be awesome if we will show current live stream as first video in the YT section and then two latest videos deployed to our YT account. If there is nothing live then the last three videos.

Yepp, there is an option in API to distinguish between live videos and recorded ones. But it can't happen that we live stream that video on our website, because Youtube API only returns thumbnails and the information related to the videos. I recommend you to check the Youtube API here - https://developers.google.com/youtube/v3/docs/search/list. I may be wrong here somewhere. If you find any option of live streaming Youtube videos on the website, do tell me 🙂.

@magicmatatjahu
Copy link
Member

should say you are right in the motive you want to show, but let me tell you a brief on how Twitter embed will look. Do check out this link - https://developer.twitter.com/en/docs/twitter-for-websites/timelines/overview. If you see, if we make that twitter section in middle, the text size inside the embed (where we have no control) will become very much larger than the outside text size on the website. It may not look good for it. I analyzed the size of the embed and the properties it will show, I found that place perfect and of correct dimension for the embed. Coming to the Youtube section, I think we have to show the thumbnail and title of the video in correct dimensions so that it becomes readable to everyone. So, I found the middle section appropriate for it. But if you think, we should give more influence to Twitter, then I will change the design a little bit, making it to center.

Ok! Thanks for explanation. Let's wait for @mcturco feedback. But could we just change the order of these sections? Blog posts, twitter, YT?

Yepp, there is an option in API to distinguish between live videos and recorded ones. But it can't happen that we live stream that video on our website, because Youtube API only returns thumbnails and the information related to the videos. I recommend you to check the Youtube API here - https://developers.google.com/youtube/v3/docs/search/list. I may be wrong here somewhere. If you find any option of live streaming Youtube videos on the website, do tell me 🙂.

I had in mind thumbnail of that live stream :) So it's ok for me.

@ritik307
Copy link
Contributor Author

ritik307 commented Mar 2, 2022

@akshatnema The design looks good but the colour theme is off as per the theme used by the official async API website. Can you kindly look into that? blush

@ritik307 If you see PR #534, made by @mcturco, she is going to change the theme and styling of the website very soon. So, I have made the section according to the latest theme.

Also, I messaged you in Slack regarding this. Kindly do check there as well.

sorry for the inconvenience caused 🙁. I was unaware of the new designs.

@mcturco
Copy link
Member

mcturco commented Mar 2, 2022

@akshatnema Hi! Do you mind if I copy your file and make some tweaks so that the UI matches the design system of the new website styles?

@akshatnema
Copy link
Member

@akshatnema Hi! Do you mind if I copy your file and make some tweaks so that the UI matches the design system of the new website styles?

@mcturco No problem at all. I thought of it before in adding this design to the website design file, but you can go with it.

@mcturco
Copy link
Member

mcturco commented Mar 2, 2022

Okay! I have created this loom video so I can explain my idea for this section. Let me know what you guys think!

Website - Newsroom Section Mockup - Watch Video

Here is the link to the Figma file -> https://www.figma.com/file/vPO7Go2C0v609Xw2L8eWS8/?node-id=287%3A723

And here is a picture of my initial layout sketch for this idea:

NewsroomMock

@akshatnema
Copy link
Member

@mcturco I completely understand your point regarding the mess I made in design 😄. Truly, you made the explanation very easy for all of us and made your point correctly understandable to us ✨. So Fine, I think we should go with your design. But I have a suggestion over here that since we are making these sections so much informative to users, we should ideally keep it somewhere in middle instead of making it in last, just before the footer. There will be no importance of the latest news, streams, and tweets section to be at the very last. Already we are elongating it much through these sections, we should make it somewhere in the middle by pushing the less important stuff at last. It's my suggestion up to how I see this section split into multiple components.

Regarding your question about thumbnails of YouTube videos (in the loom video), it is already providing high-quality thumbnails that can be used in the component. I have checked it and have taken those images directly from API only 😃. Also, I see that you changed the format of the Uploaded Date in the Youtube component. Sorry to say, we can't change the format of the date 😢. Reason - YouTube API gives the date in this manner - 1970-01-01T00:00:00Z. So we can't have a date like February 22, 2022. I can capture the substring till the date has been written, but sorry can't convert it.

@magicmatatjahu
Copy link
Member

@mcturco Awesome design! I like that idea of carousel of blog posts. I wonder if we should make also carousel for YT videos, not display then vertically, but horizontal, like these blog posts and then increase number of latest videos up to 5, not 3.

I also agree that we should change order of rendering part in main page, I think that we can render that newsroom after oin our great community! section.

Also regarding this date 1970-01-01T00:00:00Z @akshatnema we can always wrap it by Date(...) instance in JS and then convert date to the {Day} {Month}, {Year} using helpers like getMonth() etc :)

@mcturco
Copy link
Member

mcturco commented Mar 2, 2022

@akshatnema @magicmatatjahu Yeah I agree with moving the section further up on the page. Under the community section I think is good!

I wonder if we should make also carousel for YT videos, not display then vertically, but horizontal, like these blog posts and then increase number of latest videos up to 5, not 3.

Yeah good idea! I can see how that looks in a mock up, it would probably just show 2 at a time, the second one overlapping off the screen like in the first section

@mcturco
Copy link
Member

mcturco commented Mar 2, 2022

Perhaps something like this:
Screen Shot 2022-03-02 at 2 25 35 PM

@akshatnema
Copy link
Member

Also regarding this date 1970-01-01T00:00:00Z @akshatnema we can always wrap it by Date(...) instance in JS and then convert date to the {Day} {Month}, {Year} using helpers like getMonth() etc :)

Thanks, I really forgot about that. Thanks for mentioning it.

So, looks like we are done with the design. Anything more we need to discuss? If not, I and @ritik307 can start working on this by dividing the work and making separate PRs for this.

@mcturco
Copy link
Member

mcturco commented Mar 2, 2022

@magicmatatjahu How would you recommend they start working on this since my PR has a lot of the styles needed and it isn't merged yet?

@magicmatatjahu
Copy link
Member

We should wait for your @mcturco PR :) Hopefully we should merge it to Friday :)

@github-actions
Copy link

github-actions bot commented Jul 1, 2022

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

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

Successfully merging a pull request may close this issue.

6 participants