website icon indicating copy to clipboard operation
website copied to clipboard

feat: press page

Open Harish-b-03 opened this issue 2 years ago β€’ 31 comments

Hello Everyone😁. Heyy @derberg , @magicmatatjahu, @Barbanio , @mcturco. This PR is the second part the Footer Update PR #808 and related to the issue #195. So as of now and as per discussions with @derberg , the press kit was added and being rendered at /press (URL) which will be linked to the press tab in the footer.

ToDo:

  • [x] Add main content (press kit)
  • [x] ~~Add index~~ (not required, as per discussion on slack)
  • [x] Move OpenGovernanceModel and History to About page

Please take a look at it. Eagerly waiting for your suggestions.

Thank youπŸ˜€

Harish-b-03 avatar Jun 16 '22 03:06 Harish-b-03

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit 7c7826b9ce7ce04954c2d76eccf1b2f323dfa403
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/631accc60f8df100083adc07
Deploy Preview https://deploy-preview-828--asyncapi-website.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Jun 16 '22 03:06 netlify[bot]

⚑️ Lighthouse report for the changes in this PR:

Category Score
πŸ”΄ Performance 34
🟠 Accessibility 88
🟠 Best practices 83
🟒 SEO 90
πŸ”΄ PWA 30

Lighthouse ran on https://deploy-preview-828--asyncapi-website.netlify.app/

github-actions[bot] avatar Jun 16 '22 03:06 github-actions[bot]

Hey @Harish-b-13 πŸ‘‹ , looking on to the page /press/index.js, is this a type of article/blog on the website to inform users about Press?

akshatnema avatar Jun 16 '22 09:06 akshatnema

Heyy @akshatnema , Kindly please go through this conversation (initial ones, where @Barbanio explained about this). Just to give a short explanation, (given by Barbanio)

The idea is to make it easier to access the information most relevant to journalists in one tab.

it's very common for any company, enterprise, or project to have a press kit, it is very important in terms of public relations and communication. It's a document that gathers all the relevant information of the project (mission, objectives, values, etc.), it could be said that it is the letter of introduction.

And there will be two tabs for this: press releases (annual report kinda thing and compilation of news) and press kit (the document with general info about AsyncAPI Initiative which Álex and Barbino worked on)

I think, better people to answer about this would be: @derberg and @Barbanio

Thank youπŸ˜€

Harish-b-03 avatar Jun 19 '22 05:06 Harish-b-03

Hi @akshatnema! Yes, it's exactly what @Harish-b-13 explains in his comment πŸ™‚

Barbanio avatar Jun 20 '22 06:06 Barbanio

@Harish-b-13 @Barbanio Yeah, I completely got it about the information we need to show on the page, but my suggestion is regarding UI. If we aren't implementing any functionality and want the information to be conveyed in a good way, I think you can use the format just like blogs. Make a .md files for the information that need to be conveyed and it will automatically get converted to JSX along with the TOC to enable good referencing. But if your plan is to have some good functionalities like Contact (mail) need to be added later, the present implementation is brilliant.

What I can see right now is a page full of important information and headings, just like the articles in AsyncAPI. I hope that you can understand my concern and give your views regarding this.

akshatnema avatar Jun 22 '22 11:06 akshatnema

Heyy @akshatnema

So AFAIK, in future, press will be having Press-releases, compilation of news/articles and Press kit. In my opinion, it would be better if it is .js format so that we can have more flexibility in the layout.

@derberg @Barbanio Please let me know your thoughts regarding this πŸ˜€

Thank youπŸ˜€

Harish-b-03 avatar Jun 22 '22 13:06 Harish-b-03

@akshatnema @Harish-b-13 I have no idea about the technical side, but I think it makes sense to do it the way that allows more options in the future.

Barbanio avatar Jun 22 '22 13:06 Barbanio

actually, I think long term if we extend it to something more than just one page, to make it easier to contribute, .md. But it is ok to do .js first. No strong opinion though

derberg avatar Jun 22 '22 14:06 derberg

my only concern is the content for the press page, as it is a kind of mix of press and about or is it a standard now that about pages are not created and all is under press?

derberg avatar Jun 22 '22 14:06 derberg

examples:

  • about https://www.postman.com/company/about-postman/
  • press https://www.postman.com/company/press-media/

so part for example about governance is great, but shouldn't it be in About, along with history?

derberg avatar Jun 22 '22 14:06 derberg

so part for example about governance is great, but shouldn't it be in About, along with history?

Yes @derberg , I think you are right. This makes sense.

Barbanio avatar Jun 22 '22 17:06 Barbanio

Heyy @derberg @Barbanio , have removed Open Governance Model and history from press page as suggested and moved Open Governance Model to about page. But, I didnt add history to about page as it is already there.

Please check once and give your suggestions

Thank youπŸ˜€

Harish-b-03 avatar Jun 24 '22 09:06 Harish-b-03

@Harish-b-03 This looks great. Thank you very much! πŸ™πŸ™‚

I have a question. Finally, will it be modified the maintainers' section?

Barbanio avatar Jun 24 '22 11:06 Barbanio

@Barbanio as @derberg suggested, we have to change the maintainers' section. That is pending till now.

But I dont know much about the works going on in AsyncAPI, as I joined just a month before. Maybe if u have any idea or if you could help me with that, would be very helpfulπŸ˜€.

@derberg how we are going to update the about page. Do you have any plan?.

@derberg @Barbanio I think, press page is completed. is there any thing have to be changed. please let me know

Thank youπŸ˜€

Harish-b-03 avatar Jun 24 '22 11:06 Harish-b-03

But I dont know much about the works going on in AsyncAPI, as I joined just a month before. Maybe if u have any idea or if you could help me with that, would be very helpfulπŸ˜€.

@Harish-b-03 Of course, I will be happy to work with you on this πŸ™‚

@derberg, the TSC is made up of maintainers, but all maintainers are in the TSC? Where can I check this?

Any special approach to writing this section?

Barbanio avatar Jun 24 '22 12:06 Barbanio

@Barbanio not all maintainers are TSC members, it is not obligatory. You can become a CODEOWNER for one repo and not join TSC like for example guys from https://github.com/asyncapi/tck/blob/master/CODEOWNERS.

We do not have yet one place that lists all maintainers, just TSC members. Would be solved with https://github.com/asyncapi/.github/issues/47#issuecomment-1046222917 but not selected for AsyncAPI Mentorship

derberg avatar Jun 28 '22 13:06 derberg

How about something like this ⬇️ to update the maintainers' section?

Committers (also known as maintainers) are the decision-makers at the repository/project level. They regularly contribute to the project and are invited by other maintainers to manage the repository, have more privileges, and approve pull requests.

The committers rule the repository, but for issues that go beyond that, there is a Technical Steering Committee (TSC). This committee comprises all the maintainers who voluntarily want to be part of this committee, thus taking responsibility for overseeing the initiative.

You can check the list of maintainers belonging to the TSC here.

Barbanio avatar Jun 30 '22 09:06 Barbanio

How about something like this ⬇️ to update the maintainers' section?

LOVE IT ❀️ I would just not add the last paragraph about growth but just linked to TSC list.

also Maintainers (also known as committers) should be Committers (also known as maintainers)

derberg avatar Jun 30 '22 13:06 derberg

Heyy @Barbanio , hope you are doing great!!.. I wanted to ask you that if you need any sort of help for the /about page please let me know. I will be happy to help you

Harish-b-03 avatar Jun 30 '22 14:06 Harish-b-03

Thank you for your feedback @derberg, I have modified the text with your suggestions.

@Harish-b-03, thanks for your willingness :) I would like to have your opinion on this text for the maintainers' section.

Barbanio avatar Jun 30 '22 22:06 Barbanio

Heyy @Barbanio , Its perfect. Let me include it in the 'about' page.

Harish-b-03 avatar Jul 01 '22 02:07 Harish-b-03

Heyy @derberg @Barbanio @alequetzalli , I have added a short Intro section in About page, which I got from this blog post. Please have a look at it.

I think both Press and About are completed. Eagerly waiting for your suggestions πŸ˜€ .

Thank you

Harish-b-03 avatar Jul 02 '22 01:07 Harish-b-03

@derberg I think it makes sense. This information was written some time ago and some press data is out of date.

If it is decided to continue with press and about, I think it would be interesting to remove the AsyncAPI, in numbers section, since even if it is updated it will always be out of date soon.

Barbanio avatar Jul 04 '22 15:07 Barbanio

Heyy @alequetzalli :grinning: , I have made changes in AsyncAPI in numbers section. please review it.

I have resolved and made all the changes requested Lukasz . @alequetzalli If you review this section, then I can move the contents to about page and make press page to list only the links to Press-releases and articles.

@alequetzalli I request you to review the about page once again, after i merged the contents.

Thank you :smile:

Harish-b-03 avatar Jul 13 '22 01:07 Harish-b-03

Heyy @alequetzalli πŸ˜€ , I have made changes in AsyncAPI in numbers section. please review it.

I have resolved and made all the changes requested Lukasz . @alequetzalli If you review this section, then I can move the contents to about page and make press page to list only the links to Press-releases and articles.

@alequetzalli I request you to review the about page once again, after i merged the contents.

Thank you πŸ˜„

Hey @Harish-b-03 wait... I am not done reviewing yet. I am working right now and have 1/3 left. You need to wait until I finish! hahaha πŸ˜„

quetzalliwrites avatar Jul 13 '22 01:07 quetzalliwrites

Heyy @derberg @alequetzalli @Barbanio :grinning: ,

@derberg , done :+1: :+1: please take look at it.

@derberg @alequetzalli @Barbanio please review the changes and let me know the required changes

Thank you :grin:

Harish-b-03 avatar Jul 20 '22 13:07 Harish-b-03

Heyy @Barbanio , I have made those changes. please review once again. Thank you :grin:

Heyy @derberg @alequetzalli please review the changes and let me know the required changes. Thank you 😁

Harish-b-03 avatar Jul 22 '22 08:07 Harish-b-03

It looks good. Great job @Harish-b-03!

Barbanio avatar Jul 22 '22 08:07 Barbanio

@Harish-b-03 @derberg I saw the /about route and About page that is to be added via this PR. My only concern with this is we are not giving any link to this page using Navbar and it is only liked via Footer About link. I think we may lose the audience for this page as we aren't specifying any section to the press page neither in the Homepage nor in Navbar. Should we add an option inside any dropdown for press page?

akshatnema avatar Aug 29 '22 14:08 akshatnema