Skip to content

Commit 4b63c80

Browse files
adiati98BekahHW
adiati98
and
BekahHW
authored
feat: add "Becoming a Maintainer" course (OpenSource-Communities#174)
* feat: create becoming-a-maintainer folder and move maintainer course's files * feat: add assets for maintainer course * fix: internal links to assests * fix: internal links path * fix: change term tab to dashboard for consistency accross courses and minor wording adjustments * fix: minor wordings * chores: move .nojekyll to the root of docs * feat: add footer to edit page * fix: update homepage navbar * fix: update maintainer course navbar * fix: add link to maintainer course on intro to oss navbar * feat: update homepage README to include link to maintainer course and minor wording adjustments * feat: update i18n guidelines to include maintainer course * feat: update community-translations.md * feat: update CONTRIBUTING to include maintainer course * chores(index.html): add alias for maintainer course sidebar and navbar * fix: modify style for accessibility * feat: add a sentence in each chapter to navigate to the next one to accomodate github * fix: wording in homepage README * fix: relative paths * fix: remove community-translations.md from becoming-a-maintainer * Replace pizza slice with gradient * Update light theme to be similar to docs repo * Adjust dark mode to reflect docs theme * Maintain consistency by bolding key words in list * Change the favicon icon * Change the favicon icon * Adjust header img * Change header style * Stylize heading on readme * Stylize heading on readme * Add logo * Add link to sidebar logo * Add darker color for accessibility * Add alt * Change to full title * Change sidebar title * Update username in links * fix: wording in Getting Started section on both courses' README for consistency * fix: remove double quotes for dashboard * fix: wording * fix: hex color for accessibility in custom.css * fix: wording of becoming a maintainer * Use with for consistency * Implement Ayu's style suggestions * Implement new styles on intro course * Remove that logo * Bump up title size --------- Co-authored-by: Bekah Hawrot Weigel <rhawrot@gmail.com>
1 parent 5476877 commit 4b63c80

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2180
-80
lines changed

docs/intro-to-oss/.nojekyll renamed to docs/.nojekyll

File renamed without changes.

‎docs/CONTRIBUTING.md‎

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Contributions are always welcome, no matter how large or small. Before contribut
1515

1616
- If you wish to work on an open issue, please comment with `.take`, and it will be assigned to you. If an issue is not assigned, it is assumed to be available for anyone to work on. So, assign yourself to an issue before beginning work to avoid conflicts.
1717

18-
- Do you have an idea and want to add a section or a chapter to this course? Or do you spot a bug or have an idea for enhancing our course? You can create an issue to address it. But our maintainers need to triage the issue before you can work on it. If you wish to work on the issue, please tag the `@open-sauced/docs` team in the comment to notify them.
18+
- Do you have an idea and want to add a section or a chapter to a course? Or do you spot a bug or have an idea for enhancing any of our courses? You can create an issue to address it. But our maintainers need to triage the issue before you can work on it. If you wish to work on the issue, please tag the `@open-sauced/docs` team in the comment to notify them.
1919

2020
You can always ask for help in the `🍕opensauced-contributors-chat` channel on our community [Discord](https://discord.com/invite/U2peSNf23P) or [GitHub Discussions](https://github.com/open-sauced/intro/discussions) if you get stuck while working on your changes or need clarification.
2121

@@ -27,7 +27,7 @@ You can always ask for help in the `🍕opensauced-contributors-chat` channel on
2727
2. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the forked repository to your local machine.
2828

2929
```bash
30-
git clone https://github.com/<your-username>/intro.git
30+
git clone https://github.com/YOUR-USERNAME/intro.git
3131
```
3232

3333
3. Navigate to and open the project in your code editor.
@@ -120,11 +120,13 @@ Live Server extension allows you to launch a local development server and previe
120120

121121
## Working with the Content
122122

123-
The contents of this course are written in [Markdown](https://www.markdownguide.org/). Please read the "[Using Markdown for This Project](#using-markdown-for-this-project)" section for details about how to use Markdown in this project.
123+
The contents of our courses are written in [Markdown](https://www.markdownguide.org/), a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way.
124+
125+
Please read the "[Using Markdown for This Project](#using-markdown-for-this-project)" section for details about how to use it in this project.
124126

125127
### Adding Definitions to the Glossary
126128

127-
If you add definitions to the "[Glossary](./intro-to-oss/glossary.md)" chapter, ensure the definitions are added in **alphabetical order**.
129+
If you add definitions to the "Glossary" chapter in the [Intro to Open Source](./intro-to-oss/glossary.md) or [Becoming a Maintainer](./becoming-a-maintainer/glossary.md) course, ensure the definitions are added **alphabetically**.
128130

129131
### Adding a New Section to a Chapter
130132

@@ -134,7 +136,7 @@ You can add a new chapter if it's more suitable for a standalone section.
134136

135137
### Adding a New Chapter and Adding it to the Sidebar
136138

137-
In this section, we will walk you through how to add a new chapter to our Intro to Open Source course and add it to the sidebar.
139+
In this section, we will walk you through adding a new chapter to any of our courses and adding it to the sidebar.
138140

139141
#### Adding a New Chapter
140142

@@ -191,15 +193,9 @@ After your contribution is accepted, your new chapter will become part of our co
191193

192194
## Using Markdown for This Project
193195

194-
We have a [style guide](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md) to use Markdown for our projects. So, when contributing to this project, you must follow this convention.
195-
196-
### Markdown Basics
197-
198-
Markdown is a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way.
199-
200-
Below are some Markdown elements that you will commonly use in this project with examples, following our style guide:
196+
When contributing to this project, you must follow our Markdown convention below:
201197

202-
#### 1. Headings
198+
### 1. Headings
203199

204200
Use the hash (`#`) symbol to create headings (titles and subtitles). There are six levels of section headings, and the number of symbols indicates the heading level.
205201

@@ -209,7 +205,7 @@ Use the hash (`#`) symbol to create headings (titles and subtitles). There are s
209205
## Heading 2
210206
```
211207

212-
#### 2. Text Formatting
208+
### 2. Text Formatting
213209

214210
- Make text bold by enclosing it with double asterisks (`**`).
215211
- Make text italic by enclosing it with single underscores (`_`).
@@ -223,7 +219,7 @@ _This is an italic text._
223219
This is an `inline code`.
224220
```
225221

226-
#### 3. Lists
222+
### 3. Lists
227223

228224
- Create ordered lists using numbers followed by a period (`1.`, `2.`, etc.).
229225
- Create unordered lists using hyphens (`-`).
@@ -236,31 +232,31 @@ This is an `inline code`.
236232
- Unordered Item 2
237233
```
238234

239-
#### 4. Links
235+
### 4. Links
240236

241237
Create links using square brackets (`[]`) for the link text and parentheses (`()`) for the URL.
242238

243239
```markdown
244-
[Intro to Open Source with OpenSauced](https://intro.opensauced.pizza/#/)
240+
[Open Source Education Path with OpenSauced](https://intro.opensauced.pizza/#/)
245241
```
246242

247-
#### 5. Images
243+
### 5. Images
248244

249245
Embed images using an exclamation mark (`!`), followed by square brackets (`[]`) for the alt text, and parentheses (`()`) for the image URL.
250246

251247
```markdown
252248
![Create new repository on GitHub](../_assets/images/new-repo.png)
253249
```
254250

255-
#### 6. Blockquotes
251+
### 6. Blockquotes
256252

257253
Create blockquotes using the greater-than symbol (`>`).
258254

259255
```markdown
260256
> This is a blockquote.
261257
```
262258

263-
#### 7. Code Blocks
259+
### 7. Code Blocks
264260

265261
Create code blocks using triple backticks (` ``` `) for fenced code blocks and specify a language next to the backticks before the fenced code block to highlight the syntax.
266262

@@ -278,6 +274,6 @@ git pull
278274
- Use code blocks to highlight code snippets or configuration examples.
279275
- Check out the official [Markdown Guide](https://www.markdownguide.org/basic-syntax/) website for more information about using Markdown.
280276

281-
## Translating the Intro to Open Source Course
277+
## Translating the Courses
282278

283-
Translating our Intro to Open Source course helps make it more accessible to a broader audience. If you're interested in translating this course, please read our [🌐 i18n Guidelines](i18n-guidelines.md) page.
279+
Translating our Intro to Open Source and Becoming a Maintainer courses helps make them more accessible to a broader audience. If you want to translate one of these courses, please read our [🌐 i18n Guidelines](i18n-guidelines.md) page.

‎docs/README.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
<div align="center">
2-
<img alt="OpenSauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
3-
<h1>🍕 Open Source Education Path with OpenSauced 🍕</h1>
1+
2+
<div style="text-align: center; padding: 20px;">
3+
<h1 style="font-size: 3em; font-family: 'Arial', sans-serif; font-weight: bold; margin: 10px 0;">
4+
The Open Source Education Path with
5+
<span style="background: linear-gradient(to right, #e74c3c, #e67e22); -webkit-background-clip: text; color: transparent;">
6+
OpenSauced
7+
</span> </h1>
48
</div>
59

6-
Welcome to the Open Source Education Path with OpenSauced!
10+
11+
**Welcome to the Open Source Education Path with OpenSauced!**
712

813
Open source projects offer potential for personal growth, networking and collaboration, and meaningful community contributions. Because of this, there is a growing interest in open source and a need for resources to help people get started.
914

@@ -15,17 +20,19 @@ At OpenSauced, we aim to empower contributors, maintainers, and teams in open so
1520

1621
This course is designed to equip you with the skills and knowledge you need to contribute to open source projects. It offers engaging exercises to help you begin your journey towards becoming a successful contributor, and even provides an opportunity to get your first pull request merged.
1722

18-
**Head to our [Intro to Open Source](./intro-to-oss/README.md) course to start your learning journey!**
23+
**Head to our [Intro to Open Source](./intro-to-oss/README.md) course to start your contributing learning journey!**
1924

20-
### Becoming a Maintainer — Coming Soon!
25+
### Becoming a Maintainer
2126

2227
This course is designed to aid people who are interested in becoming open source project maintainers. It guides you through maintainers' best practices and provides resources and tools that help maintainers perform their tasks. This course is equipped with a tutorial for you to get practical.
2328

29+
**Head to our [Becoming a Maintainer](./becoming-a-maintainer/README.md) course to start your maintainer learning journey!**
30+
2431
## **Contributing to Our Courses**
2532

2633
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.
2734

28-
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).
35+
If you want to translate our Intro to Open Source or Becoming a Maintainer course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).
2936

3037
## **Community**
3138

‎docs/_assets/gifs/create-github-project.gif‎

713 KB
Loading

‎docs/_assets/gifs/highlight.gif‎

1.54 MB
Loading

‎docs/_assets/gifs/issues-template.gif‎

12.8 MB
Loading

‎docs/_assets/gifs/org-permissions.gif‎

8.84 MB
Loading

‎docs/_assets/gifs/saved-replies.gif‎

241 KB
Loading

‎docs/_assets/gifs/set-up-repo.gif‎

3.06 MB
Loading

‎docs/_assets/gifs/team-sync-insights.gif‎

429 KB
Loading

0 commit comments

Comments
 (0)