Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Commit

Permalink
docs: final check before launch (#58)
Browse files Browse the repository at this point in the history
* fix: adjust wording in intro chapter

* fix: adjust wording in How to Setup Your Open Source Project chapter

* fix: add space in intro chapter

* fix: wording in issues-and-pull-requests.md

* fix: update maintainer-powerups.md

* fix: change codeowners example to the one at docs

* fix: typo and adjust wording

* fix: adjust wording in building community chapter

* fix: adjust wording in communication and collaboration chapter

* fix: adjust wording in maintaining code quality chapter

* fix: update i18-n guidelines

* feat: add community-translations.md

* feat: add content in community translations

* feat: add links to the community translations

* fix: update main title in CONTRIBUTING

* fix: add wording in i18n guidelines

* fix: titles in README

* fix: adjust wording in setup project chapter

* fix: adjust wording in issues and pull requests chapter

* fix: adjust wording in maintainer power ups chapter

* fix: adjust wording in your team chapter

* fix: adjust wording in building community chapter

* fix: adjust wording in communication chapter

* fix: adjust wording in maintaining code quality chapter

* fix: minor wording in metrics and analytics chapter

* fix: minor wording adjustment in getting practical chapter

* fix: delete resources from sidebar

* chores: move files from images to img folder

* chores: move files from gifs to gif

* fix: relative paths to image and gif

* feat: add a step to create new branch to CONTRIBUTING

* feat: highlight notes with special syntax in CONTRIBUTING

* fix: links and format in translations guidelines

* fix: capitalization

* fix: update columns in kanban board

* fix: update kanban board content

* Add pagination

* feat: add a blog post to onboarding new team members

* feat: add a blog post to addiional resources

* fix: add an instruction to create a workspace

* fix: change tab to dashboard for consistency

---------

Co-authored-by: BekahHW <[email protected]>
  • Loading branch information
adiati98 and BekahHW authored Apr 25, 2024
1 parent 85d2dcb commit bb52f8b
Show file tree
Hide file tree
Showing 19 changed files with 278 additions and 240 deletions.
16 changes: 12 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to OpenSauced Intro
# Contributing to OpenSauced Becoming a Maintainer Course

Contributions are always welcome, no matter how large or small. Before contributing, please read the [Code of Conduct](https://docs.opensauced.pizza/contributing/code-of-conduct/) and follow the directions in this guide.

Expand Down Expand Up @@ -36,7 +36,15 @@ You can always ask for help in the `🍕opensauced-contributors-chat` channel on
cd maintainer-intro-course
```

4. Run the project.
4. Create a new branch to work on your changes.

```bash
git checkout -b YOUR-BRANCH-NAME
```

Replace "YOUR-BRANCH-NAME" with a descriptive name for your branch — for example, `feat/add-submit-button`.

5. Run the project.

### Running the Project Locally

Expand Down Expand Up @@ -136,13 +144,13 @@ Follow these steps to add a new chapter to our course:

Create a new Markdown (`.md`) file in the root and name the file to reflect the chapter's content—for example, `how-to-contribute-to-open-source.md` for a chapter about how to contribute to open source.
> **NOTE**: Be sure to follow naming conventions. Notice that file names are not capitalized, and there are hyphens in place of spaces between words.
!> Be sure to follow naming conventions. Notice that file names are not capitalized, and there are hyphens in place of spaces between words.
2. **Write content**.
Open the newly created Markdown file in a text editor and write the content for your chapter using the Markdown syntax. You can include headings, text, images, links, lists, and other elements to present your information effectively.
> **Note**: There should only be **one** `heading 1` in each file.
!> There should only be **one** `heading 1` in each file.
3. **Test your changes**.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Happy learning and contributing!

---

## 🤝 Contributing to this Repository
## 🤝 Contributing to OpenSauced Becoming a Maintainer Repository

We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing Guidelines](CONTRIBUTING.md) for information on how to contribute.

Expand Down
1 change: 1 addition & 0 deletions additional-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ On this page, you will find additional resources to help you learn more about al
- [New Maintainer Resources Series](https://dev.to/bekahhw/series/25520)
- [Maintainer Toolkit Series](https://dev.to/bekahhw/series/24725) by BekahHW
- [Maintainer Toolkit Series](https://dev.to/nickytonline/series/24726) by Nick Taylor
- [The Missing Piece: Why Your Project Needs a Maintainer Onboarding Process](https://dev.to/opensauced/the-missing-piece-why-your-project-needs-a-maintainer-onboarding-process-np0)
- [Scaling Open Source Projects: Navigating Challenges](https://dev.to/opensauced/navigating-the-challenges-of-scaling-open-source-projects-11h2)
- [Collaborate, Conquer, & Grow: Mastering the Art of Issue Management for Open Source Projects](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi)
- [The Lonely Journey of Open-Source Maintainers: A Call for Connection and Recognition](https://dev.to/opensauced/the-lonely-journey-of-open-source-maintainers-a-call-for-connection-and-recognition-2ghe)
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
34 changes: 17 additions & 17 deletions building-community.md

Large diffs are not rendered by default.

60 changes: 31 additions & 29 deletions communication-and-collaboration.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions community-translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Community Course Translations

We are grateful for the contributions of the community in translating this course. Although the OpenSauced team does not currently maintain these projects, we want to share the forked copy of the repositories with those taking the course. Below, you will find the latest community translations.
8 changes: 4 additions & 4 deletions getting-practical.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Sometimes, the hardest part is deciding what you will work on. Here are some gen
- Think about a topic you're passionate about that others might be interested in.
- Think about a problem you've had to solve that others can benefit from.

Don't think too hard about it now. You can always go back and update things later. For now, if you need a place to get started, let's create a repository about your favorite open source resources.
Don't think too hard about it now. You can always go back and update things later. For now, if you need a place to start, let's create a repository about your favorite open source resources.

## Creating Your Repository

Expand All @@ -28,7 +28,7 @@ We will walk through the steps to set up your project in GitHub. Although it's n
- Initialize the repository with a README file and add a license.
- Click the "Create repository" button.

![setting up a repo](./assets/gifs/set-up-repo.gif)
![setting up a repo](./assets/gif/set-up-repo.gif)

If you're using our starter idea, you could use the following:

Expand Down Expand Up @@ -319,7 +319,7 @@ body:
- In your repository, click the "Issues" tab and then the "New issue" button.
![create issue](./assets/images/create-issue.png)
![create issue](./assets/img/create-issue.png)
- Select the type of issue you want to create. In this example, we'll select Feature Request.
- Write your issue. If you're following along the example, we'll write a feature request for a new resource:
Expand All @@ -334,7 +334,7 @@ body:

- Once you've completed the issues, click "Submit new issue."

![feature-form.png](./assets/images/feature-form.png)
![feature-form.png](./assets/img/feature-form.png)

### Promoting Your Project

Expand Down
Loading

0 comments on commit bb52f8b

Please sign in to comment.