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

docs: final check before launch #58

Merged
merged 49 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
579f79e
fix: adjust wording in intro chapter
adiati98 Feb 17, 2024
f6f9e81
Merge branch 'main' of https://github.com/open-sauced/maintainer-intr…
adiati98 Feb 18, 2024
94000c0
Merge branch 'main' of https://github.com/open-sauced/maintainer-intr…
adiati98 Feb 20, 2024
d56257d
fix: adjust wording in How to Setup Your Open Source Project chapter
adiati98 Feb 21, 2024
d5c22cd
fix: add space in intro chapter
adiati98 Feb 21, 2024
749a8b7
fix: wording in issues-and-pull-requests.md
adiati98 Mar 5, 2024
19f79aa
fix: update maintainer-powerups.md
adiati98 Mar 5, 2024
a9e606c
fix: change codeowners example to the one at docs
adiati98 Mar 6, 2024
a01f637
fix: typo and adjust wording
adiati98 Mar 6, 2024
8bdff11
Merge branch 'main' of https://github.com/open-sauced/maintainer-intr…
adiati98 Mar 8, 2024
4a991e6
fix: adjust wording in building community chapter
adiati98 Mar 8, 2024
3bea072
fix: adjust wording in communication and collaboration chapter
adiati98 Mar 8, 2024
5cb37bf
fix: adjust wording in maintaining code quality chapter
adiati98 Mar 8, 2024
f049f14
fix: update i18-n guidelines
adiati98 Mar 10, 2024
e25bd7b
feat: add community-translations.md
adiati98 Mar 10, 2024
1c63efb
feat: add content in community translations
adiati98 Mar 10, 2024
f170537
feat: add links to the community translations
adiati98 Mar 10, 2024
1f51214
fix: update main title in CONTRIBUTING
adiati98 Mar 10, 2024
035a060
fix: add wording in i18n guidelines
adiati98 Mar 10, 2024
6982d42
fix: titles in README
adiati98 Mar 10, 2024
be804ed
fix: resolve merge conflicts
adiati98 Mar 11, 2024
8d3f6a4
fix: resolve merge conflicts
adiati98 Apr 4, 2024
420df74
fix: adjust wording in setup project chapter
adiati98 Apr 6, 2024
764b098
fix: adjust wording in issues and pull requests chapter
adiati98 Apr 6, 2024
4e6feb4
fix: adjust wording in maintainer power ups chapter
adiati98 Apr 6, 2024
8cda379
fix: adjust wording in your team chapter
adiati98 Apr 6, 2024
36f3b63
fix: adjust wording in building community chapter
adiati98 Apr 6, 2024
58eaf73
fix: adjust wording in communication chapter
adiati98 Apr 6, 2024
23d77d2
fix: adjust wording in maintaining code quality chapter
adiati98 Apr 6, 2024
d056322
fix: minor wording in metrics and analytics chapter
adiati98 Apr 6, 2024
067b518
fix: minor wording adjustment in getting practical chapter
adiati98 Apr 6, 2024
ba45929
fix: delete resources from sidebar
adiati98 Apr 6, 2024
9382d20
chores: move files from images to img folder
adiati98 Apr 7, 2024
de8d29c
chores: move files from gifs to gif
adiati98 Apr 7, 2024
43ab7e8
fix: relative paths to image and gif
adiati98 Apr 7, 2024
bc770cc
feat: add a step to create new branch to CONTRIBUTING
adiati98 Apr 7, 2024
a10606b
feat: highlight notes with special syntax in CONTRIBUTING
adiati98 Apr 7, 2024
bf97c9f
fix: links and format in translations guidelines
adiati98 Apr 7, 2024
25a7feb
fix: capitalization
adiati98 Apr 7, 2024
fbf9c7b
fix: update columns in kanban board
adiati98 Apr 7, 2024
15f63f5
fix: update kanban board content
adiati98 Apr 7, 2024
2a517eb
resolve merge conflicts
adiati98 Apr 7, 2024
5f86f79
fix: resolve merge conflicts
adiati98 Apr 23, 2024
ab2c936
Add pagination
BekahHW Apr 24, 2024
caca074
feat: add a blog post to onboarding new team members
adiati98 Apr 25, 2024
db7509a
Merge branch 'fix/final-check' of https://github.com/open-sauced/main…
adiati98 Apr 25, 2024
8c344c1
feat: add a blog post to addiional resources
adiati98 Apr 25, 2024
1c661ce
fix: add an instruction to create a workspace
adiati98 Apr 25, 2024
9f0c846
fix: change tab to dashboard for consistency
adiati98 Apr 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
119 changes: 67 additions & 52 deletions how-to-setup-your-project.md

Large diffs are not rendered by default.

33 changes: 21 additions & 12 deletions i18n-guidelines.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# 🌐 i18n Guidelines

Welcome to our i18n Guidelines! We appreciate your interest in translating our Intro to Open Source course.
Welcome to our i18n Guidelines! We appreciate your interest in translating our Becoming a Maintainer with OpenSauced course.

At the moment, we have the course in the following languages:

- English
- [English](./README.md)

## How Can I Contribute?

There are two types of i18n contributions that we accept:

1. Translate our Intro to Open Source course.
1. Translate our Becoming a Maintainer with OpenSauced course.
2. Review pull requests (PRs) and translations.

### Translate the Intro to Open Source Course
### Translate the Becoming a Maintainer with OpenSauced Course

We have two types of translations:

Expand All @@ -23,9 +23,9 @@ Official translations start as a post on our [discussion board](https://github.c

#### 2. Community Translations

We can't always support the maintenance of translations. However, we know some contributors are willing to translate, and we value these contributions. For that reason, we have a Community Translations section.
We can't always support the maintenance of translations. However, we know some contributors are willing to translate, and we value these contributions. For that reason, we have a [Community Translations](./community-translations.md) section.

If you're interested in translating our Intro to OSS course, fork this repository and add the translation to your forked repository. Then, you can add a link to your translation in the `community-translations.md` file.
If you're interested in translating our Becoming a Maintainer with OpenSauced course, fork this repository and add the translation to your forked repository. Then, you can add a link to your translation in the [`community-translations.md`](./community-translations.md) file that you can find in the root directory.

We encourage you to add it to the [discussion board](https://github.com/open-sauced/maintainer-intro-course/discussions) as well. We will consider moving it to an official translation if it becomes popular and has enough support.

Expand All @@ -35,22 +35,22 @@ If you are familiar with the translated language(s), you can help us review the

## Adding Translations

First, please read our [Contributing Guide](CONTRIBUTING.md) to setting up the project locally and for the technical instruction. Then, follow these steps to add the translations:
First, please read our [Contributing Guide](./CONTRIBUTING.md) to setting up the project locally and for the technical instruction. Then, follow these steps to add the translations:

1. **Identify target languages**.

Determine which languages you want to add translations for. Make sure these languages are relevant to the project's user base.

2. **Create translation files**.

Inside the "translations" directory, create a new subdirectory for each language you plan to support. Use language codes (e.g., "en" for English, "fr" for French) as directory names.
Inside the "translations" directory, create a new subdirectory for each language you plan to support. Use language codes (e.g., "en" for English, "fr" for French, etc.) as directory names.

```markdown
.
└── translations/
β”œβ”€β”€ en/ (English)
β”œβ”€β”€ fr/ (French)
└── es/ (Spanish)
β”œβ”€β”€ en/
β”œβ”€β”€ fr/
└── es/
```

3. **Translate content**.
Expand Down Expand Up @@ -100,4 +100,13 @@ When it comes to reviewing a translation PR, ask yourself the following question
- Are there links that could be localized and translated? (e.g., Wikipedia and MDN links)
- Is the translation correctly written following the translated language's norms and practices?

When you think a PR is ready to be merged after your suggestions were addressed (if any), approve it through GitHub's "Review Changes" button or leave an "LGTM!" in the comment section and tag the `@open-sauced/docs` maintainers. (β€œLGTM” is an abbreviation of β€œLooks Good to Me” or β€œLet’s Get to Merging”, often used to approve pull requests.)
When you think a PR is ready to be merged after your suggestions were addressed (if any):

1. Click the "Files changed" tab under the PR's title.
2. Click the green "Review changes" button.
3. Select "Approve."
4. Click the green "Submit review" button.

Alternatively, you can leave an LGTM\* in the comment section and tag the `@open-sauced/docs` maintainers.

?> \*LGTM is an abbreviation of β€œLooks Good to Me” or β€œLet’s Get to Merging”, often used to approve pull requests.
1 change: 1 addition & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,6 @@
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"
type="text/javascript"
></script>
<script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
</body>
</html>
Loading