docs VS intro

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

Walk reviewers through your code, highlighting your changes' "what" and "why." Be generous with examples and explanations. Think of it as a user guide for your changes. If your PR contains several changes, as in this example, consider using bullet points or checklists. Bottom line: The PR description should give reviewers an immediate understanding of your changes.

If you're new to open source, and you're not sure where to start, check out our Intro to Open Source course. We recently created a new feature for Repository Pages, so if you want to see how your repository has progressed, you can go to:

If you like this post, watch our Intro repo where we'll be launching a new intro course for maintainers soon!

As one of the docs maintainers for OpenSauced, I find it helpful to track our docs team to make sure I'm supporting them and to see the progress we're making. (You'll see some huge work shipped from this team in the next couple of weeks on the Intro Repo, when we launch our maintainer course!)

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.

This guestbook is a place for people who have taken OpenSauced's Intro to Open Source course to take their first steps into contributing to open source.

- name: Post comment for course contributors if: contains(github.event.pull_request.title, 'as a contributor') run: | PR_COMMENT="Congratulations on completing Chapter 5 of the Intro to OSS Course with your contribution to this repository! You're almost to the end of the course. Create a [highlight](https://app.opensauced.pizza/feed) of your contribution to our guestbook using the instructions in [chapter 6](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md) and share it with us!" curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -X POST -d "{\"body\":\"$PR_COMMENT\"}" "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"

If you're new to open source, and you're not sure where to start, check out our Intro to Open Source course.

Yet, technical prowess was only a part of my journey. I was drawn into the enchanting realm of open-source development. It was as if I had stumbled upon a hidden treasure trove of collaboration and innovation. With bated breath, I clicked on a link that read https://github.com/open-sauced/intro. Little did I know that this click would forever alter the course of my story.

If you want to get some hands-on experience using git, check out OpenSauced's Intro to Open Source Course or sign-up for one of our workshops that are listed on the bottom of our #100DaysOfOSS Challenge docs.