feat: adding GSoD and GSoC pages #642

alequetzalli · 2022-03-30T23:41:33Z

Contribution Description

The purpose of this PR is to create 2 NEW pages on our website for /GSoD (Google Season of Docs) and /GSoC(Google Summer of Code). In addition to adding those 2 pages to our website, I'm also proposing adding nav links to these pages under the Community nav group.

I truly love the idea of having them under Community because they are (potentially) a huge group event to do with the whole community. It just seemed to fit under that section best. But I know (as you can see too) that the sub-nav <li>s look like a long list now, so I will understand if you folks are wondering about that. Perhaps the styling should change to make the dropdown be a wider rectangle horizontally vs the current vertical grid?

Page sources

netlify · 2022-03-30T23:41:40Z

❌ Deploy Preview for asyncapi-website failed.

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`96108ee`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/62a99f5684a9d600083fb14a

alequetzalli · 2022-03-30T23:54:36Z

Questions

Hey @derberg and @magicmatatjahu, I have a few development questions since this is the first time I add new pages to the website outside of the Docs markdown arena. 😄

Problem 1

Regardless of what I tried, HTML <table> and <ul> elements don't display as expected.

The 🟩 box shows <ul> elements
The 🟦 box shows a <table> element

In fact, there is only 1 section that displays the · (list item bullet point) as expected in the <ul> element:

When I compare the code samples, the only diff seemed to be that one of the <ul> elements had it's own <div>. So I tried to shuffle the other <ul> elements and give them their own <div>s to see if that fixed it. It didn't, 😂 so I put them back as they were:

Problem 2

When I open my 8080 localhost link to preview these pages, the website's main navigation seems to disappear!

What did I do? Where did it go? 🙊😂😂

alequetzalli · 2022-03-30T23:56:34Z

pages/community/gsoc.js

+              <Paragraph className="mt-4 lg:pr-4">
+              AsyncAPI already participated in GSoC in 2021. We were not accepted as organization, but it was also a time when we were not yet part of the Linux Foundation. Therefore some of AsyncAPI maintainers pushed their ideas through Postman (that was accepted for GSoC) because they were Postman employees working on AsyncAPI. So far so good?
+              <br></br>
+              We mentored 5 mentees. All of them successfully completed GSoC. As a result, all of them became members of our Technical Steering Committee and also presented their solutions at AsyncAPI Conference 2021:


@derberg, in my 1st commit to this PR, I didn't add hyperlinks yet. Right now, the 2 NEW pages only have text.

In my 2nd commit, I will be adding the links via the <a> tag, unless you folks tell me I made these pages wrong.

Thanks! ☺️

akshatnema

The points I added for gsoc page, same goes with gsod page as well. I think you need to explore the tailwind classes more because table can be implemented in better way instead of using <table> tag. Do checkout grids in the tailwindcss. They provide more features and good responsiveness.

akshatnema · 2022-04-01T18:09:14Z

pages/community/gsoc.js

+export default function GSoCPage() {
+
+  return (
+      <div className="py-12 overflow-hidden">


You need to put this whole content inside GenericLayout component to use it. You have imported it but not used it here. Do check this for further explanation.

akshatnema · 2022-04-01T18:13:21Z

pages/community/gsoc.js

+              <br></br>
+              We mentored 5 mentees. All of them successfully completed GSoC. As a result, all of them became members of our Technical Steering Committee and also presented their solutions at AsyncAPI Conference 2021:
+
+              <ul>


This unordered list will not show the bullet points due to the basic CSS implemented in the repo. It automatically adds the list-style:none property to every <ul> tag. You have to add the classes to this tag in order to show it. They are className="list-disc pl-8"

akshatnema · 2022-04-01T18:17:14Z

pages/community/gsoc.js

+              </Heading> 
+              <Paragraph className="mt-4 lg:pr-4">
+              Proposals can be submitted either as GitHub Discussion or GitHub Issue in AsyncAPI GitHub organization.
+              <br></br>


If you are making the points, better you make them using <ul> tag instead of using <br> tag everywhere. Also, <br> is a self-closing tag, so it should be used like this <br />, not like this <br></br>.

akshatnema · 2022-04-01T18:22:11Z

components/navigation/communityItems.js

@@ -3,5 +3,7 @@ export default [
  { text: 'Github Organization', href: 'https://github.com/asyncapi', target: '_blank', description: 'Want to sneak in the code? Everything we do is open-sourced in our Github organization.' },
  { text: 'Slack Workspace', href: 'https://asyncapi.com/slack-invite', target: '_blank', description: `Need help? Want to share something? Join our Slack workspace. We're nice people :)` },
  { text: 'Contributing', href: 'https://github.com/asyncapi?type=source#-contribute-to-asyncapi', target: '_blank', description: `We are always welcoming and looking for contributions. If you are interested check out our contribution guide.` },
-  { text: 'Technical Steering Committee', href: '/community/tsc', description: 'Get to know what is a TSC member, how you can become one, and meet our current TSC members.' }
+  { text: 'Technical Steering Committee', href: '/community/tsc', description: 'Get to know what is a TSC member, how you can become one, and meet our current TSC members.' },
+  { text: 'Google Season of Docs (GSoD)', href: '/community/gsod', description: 'All technical writers are welcome to participate, regardless of tech background or years of experience!' },


The addition of these 2 options in the dropdown of Community actually makes it quite responsive. On smaller screens, these last 2 options are not seen while opening the Community dropdown. We need to provide a scroll if you think these options are to be added necessarily. Here's the preview:

akshatnema · 2022-04-01T18:27:41Z

pages/community/gsod.js

+            We have set aside 2 mentors for now, for our 2 projects: improving our IA and re-structuring our Generator Docs. Should we be selected, AsyncAPI would like to request from Google a US $5000 budget for each project. For both projects, the request then totals for a $10,000 budget.
+            </Paragraph>
+
+            <table>


If you want to format the table a bit more and look like some colors and border to be added. I advise using a grid instead of a table for this. Here's the documentation for it.

Let me disagree. If this is a table, it should be a table element. Appearance (CSS) should not influence the type of HTML tag you choose. The same you advised her above about using <ul> and <li> tags instead of <br> tags applies here.

I am also quite surprised with the behavior of the base.css applied in this element. It is adding list-style:none to the <ul> tag by default. You can check this in the developer tools in the preview URL. On running this PR locally, I found that on adding above mentioned classes, it is working fine and giving the properties it needs to show in the table.

fmvilas · 2022-04-05T19:17:40Z

pages/community/gsoc.js

@@ -0,0 +1,100 @@
+import GenericLayout from '../../components/layout/GenericLayout'


We're not participating in GSoC this year. Do we need this? 🤔

Yes @fmvilas, it's not a 2022 page. It's a generic page for our org that contains all needed info from OUR END on what we do/how we work in GSoC. This page should also include previous years and detail when we were accepted/declined. The page's purpose is to showcase how our OSS org provides mentorship/teaming for the program, regardless of acceptance.

It would help if you looked up how some OSS orgs make a page specific for the program but not for the sole year of application. Here's an example from Jenkins and git to help you get started.

For more examples of orgs that in general create a page in their main OSS site for the GSoC program, another example is Django and Joplin.

Other OSS orgs create subdomains for this, such as the Apache Foundation, GNOME, and Python.

Many OSS orgs create a GH GSoC repo with READMEs as their org page, such as CNCF, Numfocus, Homebrew, and Open Robotics. Alternatively, some create a GH wiki for it, such as R and Ruby.

And lastly, you should learn how other OSS orgs opt to create a Wiki page for this, such as LAN video, PostgreSQL and the Linux Foundation.

fmvilas · 2022-04-05T19:20:41Z

pages/community/gsod.js

+            We have set aside 2 mentors for now, for our 2 projects: improving our IA and re-structuring our Generator Docs. Should we be selected, AsyncAPI would like to request from Google a US $5000 budget for each project. For both projects, the request then totals for a $10,000 budget.
+            </Paragraph>
+
+            <table>


Let me disagree. If this is a table, it should be a table element. Appearance (CSS) should not influence the type of HTML tag you choose. The same you advised her above about using <ul> and <li> tags instead of <br> tags applies here.

magicmatatjahu · 2022-04-06T09:51:57Z

@alequetzalli As I see, this is copy/paste of the discussion's content about GSOC and GSOD. If we wanna these sites we should render them as mdx not as html. I can help but I need "approval" from @fmvilas and @derberg that these pages are needed :)

derberg · 2022-04-07T09:17:00Z

I'm definitely up for this change. Many orgs do it for transparency reasons on their involvement in different mentorship programs. It will also make it super easy for us to share our participation and share resources in future, because some rules do not change.

My suggestion though is to not have it as asyncapi.com/community/gsoc but asyncapi.com/community/mentorship/gsoc
so we basically get:

a "docs" like landing page under asyncapi.com/community/mentorship with navigation on the left, with links to Google Summer of Code and others and some short summary about these, like even hall of fame of those that completed. Like also have CodeForce participation update, then we will have Outreachy in few months, etc. But most important, we will get also a place to describe AsyncAPI Mentorship
contend developed with markdown/mdx

alequetzalli · 2022-04-07T19:29:53Z

I'm definitely up for this change. Many orgs do it for transparency reasons on their involvement in different mentorship programs. It will also make it super easy for us to share our participation and share resources in future, because some rules do not change.

My suggestion though is to not have it as asyncapi.com/community/gsoc but asyncapi.com/community/mentorship/gsoc so we basically get:

@derberg Sure, I can move these pages into a sub-folder called community so that we end up with:

asyncapi.com/community/mentorship/gsoc
asyncapi.com/community/mentorship/gsod

a "docs" like landing page under asyncapi.com/community/mentorship with navigation on the left, with links to Google Summer of Code and others and some short summary about these, like even hall of fame of those that completed. Like also have CodeForce participation update, then we will have Outreachy in few months, etc. But most important, we will get also a place to describe AsyncAPI Mentorship

contend developed with markdown/mdx

Errrr. what now? @derberg sorry, got confused here a bit... can you show me a drawing of what you mean by "with navigation on the left, with links to Google Summer of Code and others and some short summary about these, like even hall of fame of those that completed".

(Also for the purposes of this PR, the scope is only adding these 2 pages.)

BTW, @magicmatatjahu can you confirm you know how to fix the CSS/styling issues I documented here? Lukasz was the one who told me I should tag you in this issue.

magicmatatjahu · 2022-04-08T10:08:01Z

@alequetzalli

can you confirm you know how to fix the CSS/styling issues I documented here? Lukasz was the one who told me I should tag you in this issue.

When we will move to the mdx probably all issues will be resolved :) If you want I can push some changes to your branch. Let me know :)

derberg · 2022-04-11T08:43:19Z

@alequetzalli sorry for not explaining well. I mean look at Getting Started navigation.

So by going to asyncapi.com/community/mentorship we would see in navigation like ☝🏼 elements like Google Summer of Code or Open Force or Google Season of Docs or Hacktoberfest or Outreachy or most important AsyncAPI Mentorship. So asyncapi.com/community/mentorship would be a single place where we have all different programs described and how we deal with them.

But yes, scope of this PR is GSoC and GSoD as a starter

alequetzalli · 2022-04-13T21:46:09Z

When we will move to the mdx probably all issues will be resolved :) If you want I can push some changes to your branch. Let me know :)

Yes, @magicmatatjahu you can totally push changes to my branch. You have alllll the permissions! ✨✨✨✨✨✨✨ 🙏🏽

alequetzalli · 2022-04-13T21:48:30Z

So by going to asyncapi.com/community/mentorship we would see in navigation like ☝🏼 elements like Google Summer of Code or Open Force or Google Season of Docs or Hacktoberfest or Outreachy or most important AsyncAPI Mentorship. So asyncapi.com/community/mentorship would be a single place where we have all different programs described and how we deal with them.

Huh🤔.. ok I think I get it now 😄 @derberg

derberg · 2022-04-16T16:14:34Z

removed gsoc and gsod labels as we add them to ideas issues for mentees

github-actions · 2022-04-21T11:11:01Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	52
🟠 Accessibility	74
🟠 Best practices	83
🟢 SEO	90
🔴 PWA	30

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

magicmatatjahu · 2022-04-21T11:21:27Z

@alequetzalli @derberg I added content as markdown. After merging PR with new navigation for docs I will improve navigation also for new pages in this PR, but for now we have to wait. Adding new pages for the /community/mentorship subpage is similar to adding new docs. You can check it out here: https://deploy-preview-642--asyncapi-website.netlify.app/community/mentorship

derberg · 2022-04-26T16:11:54Z

@magicmatatjahu just headings and titles are duplicated, but yeah, not code issue but fact that it is duplicated in metadata.

Looks nice ❤️

magicmatatjahu · 2022-04-26T16:13:07Z

@derberg Yeah, I duplicated the data just to show that new pages are being rendered :)

derberg · 2022-05-23T09:25:29Z

@magicmatatjahu where are we with this one?

magicmatatjahu · 2022-05-23T09:26:54Z

@derberg

#642 (comment)

After merging this PR #601 I will update navigation and you can review it :)

magicmatatjahu · 2022-06-21T08:55:43Z

We need to wait for #830

github-actions · 2022-10-20T00:27:30Z

This pull request 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 pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request 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 pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

derberg · 2023-02-28T16:13:32Z

Closing because work is done in asyncapi/community#571

Of course we can reopen if needed

alequetzalli added gsoc This label should be used for issues or discussions related to ideas for Google Summer of Code gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Mar 30, 2022

alequetzalli requested review from fmvilas and magicmatatjahu March 30, 2022 23:41

alequetzalli self-assigned this Mar 30, 2022

alequetzalli requested review from derberg and asyncapi-bot-eve as code owners March 30, 2022 23:41

alequetzalli commented Mar 30, 2022

View reviewed changes

alequetzalli added this to Community PR under Review 🧐 in AsyncAPI Docs Board Mar 31, 2022

akshatnema requested changes Apr 1, 2022

View reviewed changes

fmvilas reviewed Apr 5, 2022

View reviewed changes

derberg removed gsoc This label should be used for issues or discussions related to ideas for Google Summer of Code gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Apr 16, 2022

Rough Draft: adding GSoD and GSoC pages

e080739

magicmatatjahu added 2 commits June 15, 2022 10:58

move content to markdown

909e415

add markdown content

96108ee

magicmatatjahu force-pushed the NEW-gsoc-gsod-pages branch from 9a85aad to 96108ee Compare June 15, 2022 08:59

magicmatatjahu mentioned this pull request Jun 29, 2022

chore: split website data build process to several steps #830

Closed

github-actions bot added the stale label Oct 20, 2022

derberg removed the stale label Feb 28, 2023

derberg closed this Feb 28, 2023

derberg mentioned this pull request Feb 28, 2023

feat: add mentorship directory asyncapi/community#571

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding GSoD and GSoC pages #642

feat: adding GSoD and GSoC pages #642

alequetzalli commented Mar 30, 2022 •

edited

Loading

netlify bot commented Mar 30, 2022 •

edited

Loading

alequetzalli commented Mar 30, 2022

alequetzalli Mar 30, 2022 •

edited

Loading

akshatnema left a comment

akshatnema Apr 1, 2022

akshatnema Apr 1, 2022

akshatnema Apr 1, 2022

akshatnema Apr 1, 2022

akshatnema Apr 1, 2022

fmvilas Apr 5, 2022

akshatnema Apr 6, 2022

fmvilas Apr 5, 2022

alequetzalli Apr 6, 2022 •

edited

Loading

fmvilas Apr 5, 2022

magicmatatjahu commented Apr 6, 2022

derberg commented Apr 7, 2022

alequetzalli commented Apr 7, 2022 •

edited

Loading

magicmatatjahu commented Apr 8, 2022

derberg commented Apr 11, 2022

alequetzalli commented Apr 13, 2022

alequetzalli commented Apr 13, 2022

derberg commented Apr 16, 2022

github-actions bot commented Apr 21, 2022 •

edited

Loading

magicmatatjahu commented Apr 21, 2022 •

edited

Loading

derberg commented Apr 26, 2022

magicmatatjahu commented Apr 26, 2022

derberg commented May 23, 2022

magicmatatjahu commented May 23, 2022

magicmatatjahu commented Jun 21, 2022

github-actions bot commented Oct 20, 2022

derberg commented Feb 28, 2023

		@@ -0,0 +1,100 @@
		import GenericLayout from '../../components/layout/GenericLayout'

feat: adding GSoD and GSoC pages #642

feat: adding GSoD and GSoC pages #642

Conversation

alequetzalli commented Mar 30, 2022 • edited Loading

Contribution Description

Page sources

netlify bot commented Mar 30, 2022 • edited Loading

❌ Deploy Preview for asyncapi-website failed.

alequetzalli commented Mar 30, 2022

Questions

Problem 1

Problem 2

alequetzalli Mar 30, 2022 • edited Loading

Choose a reason for hiding this comment

akshatnema left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alequetzalli Apr 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magicmatatjahu commented Apr 6, 2022

derberg commented Apr 7, 2022

alequetzalli commented Apr 7, 2022 • edited Loading

magicmatatjahu commented Apr 8, 2022

derberg commented Apr 11, 2022

alequetzalli commented Apr 13, 2022

alequetzalli commented Apr 13, 2022

derberg commented Apr 16, 2022

github-actions bot commented Apr 21, 2022 • edited Loading

magicmatatjahu commented Apr 21, 2022 • edited Loading

derberg commented Apr 26, 2022

magicmatatjahu commented Apr 26, 2022

derberg commented May 23, 2022

magicmatatjahu commented May 23, 2022

magicmatatjahu commented Jun 21, 2022

github-actions bot commented Oct 20, 2022

derberg commented Feb 28, 2023

alequetzalli commented Mar 30, 2022 •

edited

Loading

netlify bot commented Mar 30, 2022 •

edited

Loading

alequetzalli Mar 30, 2022 •

edited

Loading

alequetzalli Apr 6, 2022 •

edited

Loading

alequetzalli commented Apr 7, 2022 •

edited

Loading

github-actions bot commented Apr 21, 2022 •

edited

Loading

magicmatatjahu commented Apr 21, 2022 •

edited

Loading