search

opensourcediversity / opensourcediversity.org

🌼 Code of https://opensourcediversity.org
https://opensourcediversity.org
GNU Affero General Public License v3.0
240 stars 89 forks source link

Migrate site to React-based framework, like Docusaurus #131

Closed jwflory closed 1 year ago

jwflory commented 3 years ago

Summary

Convert the existing website (plain HTML page) into a React-based site focused on content management, such as Docusaurus

Background

When the opensourcediversity.org website was first created, we were a smaller project with a group of people that also had in-person meet-ups to work on things like the website. Fast forward a few years and add a global pandemic in, and our site is tough to maintain in its current form.

Since there is a lot of interest in the site, and we have not made significant content changes in some time, now is a good opportunity to evaluate what we want to do. There are two goals in making a big change like this:

  1. Exciting web technologies: Use a web framework or tool that has some popularity, in the hope of getting more people involved who want to learn more about that kind of technology.
  2. Content management: Improve ease of maintenance for the resources, suggestions, and referrals we share on our website. Split up content so it is not maintained in one long HTML file.

Details

There are two sub-components to this mini-project:

Exciting web technologies

React is a popular front-end tool used in many communities, and Docusaurus is a React-based documentation tool written with close integration to upstream React. There are opportunities for us to figure out style and branding designs not only for this website, but any other websites we would want to build or host in the future.

Content management

Once the content is divided into smaller files that are easier to maintain, we can begin more active curation and review of what content is on our site. Are some resources outdated? Should we remove them? Are there new sections or new resources we can add? Where do they go?

We will need a small group of folks with an interest in this work to help out. Think of it like a librarian sort of task? :eyes:

Outcome

opensourcediversity.org is easier to contribute to, and it is easier for us to create and maintain a resource for and by the community

Victorybrown commented 3 years ago

Can you explain more on the Content Management. What is expected? Are we to research and curate resources to improve and promote Open Source D & I or Organize already existing resources? Is it a technical contribution involving codes or just writing?

IamJayashree commented 3 years ago

Hi Justin, I would like to understand more about the content management work. would like to contribute accordingly. thank you

Aashimalik commented 3 years ago

Hi All, I would love to be part of it. I'm working as a full stack developer .

jancborchardt commented 3 years ago

Before diving into the technical details, it would make sense to define how the site should look like and what kind of content we want to offer. Based on that we can make a better choice regarding the technology.

(Ultimately we could also do it with Vanilla JS and JSON for the data so it's very approachable.)

IamJayashree commented 3 years ago

Hi Team, I have about 7 front end engineers from my team who are interested to contribute. They will be commenting here soon. Let us know if any meeting required once the team shares their consensus here.

soumya-wipro commented 3 years ago

Hi Team, This is Soumya Bose. I am a full stack developer. I am looking forward to contribute my free time in this project.

krish5512 commented 3 years ago

Hi All,

I am haves started on the MERN stack and would love to contribute my free time in this project

kavitha89 commented 3 years ago

Hey Team,

I will be more than happy to help out here at this space when its related to frontend and React. Let me know. Thank You!

strivedi07 commented 3 years ago

Hi Team,

I am new to React but keen to learn and contribute in this project.

jwflory commented 3 years ago

@Victorybrown wrote… Can you explain more on the Content Management. What is expected? Are we to research and curate resources to improve and promote Open Source D & I or Organize already existing resources? Is it a technical contribution involving codes or just writing?

@IamJayashree wrote… Hi Justin, I would like to understand more about the content management work. would like to contribute accordingly. thank you

Hi @Victorybrown and @IamJayashree, I was thinking more like a knowledge-base, something like this kind of example. Right now, we have a few sections on our website that provide resources or referrals. We could push this one step further by better curating our existing content into a static site generator tool that works with Markdown source files. Then, we could brainstorm further on ideas for topics not yet covered. It gives people a chance to then share knowledge and advice as they see fit.

However, I feel like we need to first start by migrating the existing content to a new tool or framework, so we know what options and features are in place for us to utilize with the content.

I could open new GitHub issues for each section so folks could take a lead on content review and updating what we have already published on opensourcediversity.org. What do you think?

@jancborchardt wrote… Before diving into the technical details, it would make sense to define how the site should look like and what kind of content we want to offer. Based on that we can make a better choice regarding the technology.

(Ultimately we could also do it with Vanilla JS and JSON for the data so it's very approachable.)

Good point! Would it help for me to open a new issue on creating mock-ups or wireframes first? What do you think @jancborchardt?

@soumya-wipro wrote… This is Soumya Bose. I am a full stack developer. I am looking forward to contribute my free time in this project.

@krish5512 wrote… I am haves started on the MERN stack and would love to contribute my free time in this project

@kavitha89 wrote… I will be more than happy to help out here at this space when its related to frontend and React. Let me know. Thank You!

@strivedi07 wrote… I am new to React but keen to learn and contribute in this project.

Great, thanks all for commenting here! Stay tuned for more information as we get this project going. It will be a discussion topic at our next monthly meeting on July 14th.

IamJayashree commented 3 years ago

Thanks @jwflory - On your response on the content management , would request you to take sometime to explain during our monthly meeting please. Plus, let me know if you need our volunteers ( reactJS devs) to attend.

jwflory commented 3 years ago

Hi @opensourcediversity/website-committers (@ramyaparimi, @Aashimalik, @krish5512, @soumya-wipro) and invited folks (@ashlyn-knox @IamJayashree @kavitha89 @strivedi07), you are now part of the team. Welcome aboard!

Please take a look at this forum post summarizing the last meeting's discussion on the website.

Two notes of highlight:

We will need to set up a developer meeting to begin next steps to work on the website. We will begin with a requirements gathering exercise to guide us on next steps. We should begin working on a timeline to present back to the community at the next August monthly meeting.

I also created a Telegram group for developers.

When you get a chance, please join the Telegram group and say hello! Hope to chat with you all there soon. 🙂

IamJayashree commented 3 years ago

Thank you Justin

IamJayashree commented 3 years ago

Our engineering crew have joined Telegram.

LaideLawal commented 2 years ago

I am interested, I would be glad if you can count me in

gcsandesh commented 2 years ago

I would like to contribute to this migration. Although I am new to open source, I am proficient in React.

jordanwangdev commented 1 year ago

I would like to contribute to this migration too.

jonatoni commented 1 year ago

I am closing this issue as stale for now. @jwflory we can create a new issue when we start working on it.