-
-
Notifications
You must be signed in to change notification settings - Fork 584
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
feat: adding GSoD and GSoC pages #642
feat: adding GSoD and GSoC pages #642
Conversation
❌ Deploy Preview for asyncapi-website failed.Built without sensitive environment variables
|
QuestionsHey @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 Problem 1Regardless of what I tried, HTML
In fact, there is only 1 section that displays the When I compare the code samples, the only diff seemed to be that one of the Problem 2When I open my What did I do? Where did it go? 🙊😂😂 |
<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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
export default function GSoCPage() { | ||
|
||
return ( | ||
<div className="py-12 overflow-hidden"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
<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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"
</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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
.
@@ -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!' }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
@@ -0,0 +1,100 @@ | |||
import GenericLayout from '../../components/layout/GenericLayout' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're not participating in GSoC this year. Do we need this? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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'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
|
@derberg Sure, I can move these pages into a sub-folder called
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. |
@alequetzalli
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! ✨✨✨✨✨✨✨ 🙏🏽 |
Huh🤔.. ok I think I get it now 😄 @derberg |
removed |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-642--asyncapi-website.netlify.app/ |
@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 |
@magicmatatjahu just headings and titles are duplicated, but yeah, not code issue but fact that it is duplicated in metadata. Looks nice ❤️ |
@derberg Yeah, I duplicated the data just to show that new pages are being rendered :) |
@magicmatatjahu where are we with this one? |
After merging this PR #601 I will update navigation and you can review it :) |
9a85aad
to
96108ee
Compare
We need to wait for #830 |
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 ❤️ |
Closing because work is done in asyncapi/community#571 Of course we can reopen if needed |
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
/GSoC
(Google Summer of Code) page gets its details from here./GSoD
(Google Season of Docs) page gets its details from here.