Migrate site to React-based framework, like Docusaurus
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:
- 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.
- 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?
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