open-sauced VS docs

OpenSauced cultivates a thriving community of developers through its interactive forum. This virtual space provides a platform for developers to exchange ideas, seek guidance, and collaborate on projects, fostering a sense of camaraderie and shared passion for open source. All wrapped up in a nice GitHub stromboli.

In Part 3 of this series, we'll talk about our use of various plugins for Vite on the Open Sauced project. Vite provides extensibility in the form of a Plugin API, based on that of Rollup. For reference on which Rollup plugins Vite is compatible with (and to what degree), see Vite Rollup Plugins

The most straightforward fix for the circular reference was to update react-markdown through one major revision, but this introduced a new snag. In this major revision, react-markdown changed to ESM only, which would be fine for Vite, but not for our testing approach for jest (other than experimentally, so I learned. @0vortex and I got some help from @jasonericdavis on Discord to mock the react-markdown component in Jest (bypassing the need for ESM support) as part of a preparatory PR, and we got back on track.

This is Part 1 of a series about how recently in Open Sauced, we converted the project from using Webpack v4 to using Vite! A lot of what we'll cover in this series deals with PR #1322. @bdougieyo started this as a create-react-app project 5+ years ago and so this conversion certainly turned out to be an undertaking!

In contributing to Open Sauced and other OSS projects as well, I've found time and time again that there are such ample opportunities to learn. However, contributing a feature and sticking with it on a longer term can cause those opportunities to multiply! In Part 3 of this series, I'm going to talk about some of the after-effects of implementing dark mode on Open Sauced in PR #1020.

This is Part 2 of the series on Implementing Dark Mode. This was done in open-sauced/open-sauced#1020, and handily demonstrated to me the wealth of learning opportunities in contributing to Open Source. I for one have learned a ton! On this one, I got the opportunity for learning in several areas. I was still pretty new to React (and I still am), so I had not yet used the Context API. For a lot of the same reasons, I hadn't used the styled-components library before.

This tool is meant to accelerate development on Open Sauced by giving contributors a way to access Docusaurus 2 powered developer documentation available at docs.opensauced.pizza.

Expanding the @open-sauced ecosystem, it became tedious to apply all the necessary tooling available in open-sauced/open-sauced to newly created repositories and synchronising existing ones with minor updates.

I'd like to share the story behind one of my favorite contributions to Open Sauced so far, which is the addition of "Dark Mode", PR #1020. This PR touched 25 files and was pretty substantial in scope, so I'm going to break this up into 3 parts. Part 1 is here is just the background - the what and the why, as @bdougieyo sometimes says. If there's one takeaway though, it's the value of opening a PR early in your process - you can share your progress and your roadblocks, and maintainers can help you get unblocked!

Feel free to share and adapt this worksheet. We super stoked that @codergirl1991 is working on an issue for how to use OpenSauced for job seekers. So if there's more you'd like to see, let us know!

Yesterday, I decided to make some "quick" changes to the OpenSauced docs site. Now, I know that "quick changes" is essentially a bad word in tech. Anytime you say it, it will indeed not be quick. I wrote up a quick issue that described reorganizing a couple of things and adding a quick intro page. I made the changes, wrote the page, pushed my changes, and made the Pull Request (PR), only to see that I failed. Ugh. It was quick, but it wasn't right. Not really having the time to dig into it, I left my PR open and determined to get back to it the next day. Understanding why a project is failing may look different depending on how it is set up. For us, we're going to look at implementation errors, compliance issues, check the deploy log.

At OpenSauced, we’ve been working to curate a contributor journey that allows for contributors to grow. We have repositories made for new contributors, like our Intro Course, pizza-verse, and guestbook. We also include good first issue labels on some of the issues in our app, which is generally geared towards someone leaving the new stage and entering the intermediate stage. In the same way, our docs repo has a variety of issues open to different levels. And finally, there’s always space for our expert contributors across the repositories.

Yaml file link: @open-sauced/docs.opensauced.pizza/main/.github/workflows/release.yml

The full workflow is available here: .github/workflows/compliance.yml