Skip to content

Commit 58145c6

Browse files
adiati98BekahHW
adiati98
and
BekahHW
authored
chores: reorganize intro repository to welcome a new course (OpenSource-Communities#138)
* chores: move course content into intro-to-oss folder in the docs folder * chores: move files into docs folder * chores: * create _media folder in the docs folder to hold _images and _gifs folders * chores: move images and gifs to their folder * chores: move navbar and sidebar into intro-to-oss folder * fix: change folder name from _media to _assets * chores: move styles folder into docs folder * chores: move README into intro-to-oss folder * feat: add README to docs folder * feat: add _navbar and _sidebar files for main landing page * fix: update index.html * fix: update _navbar in intro-to-oss folder * fix: update _sidebar in intro-to-oss folder * chores: move navbar and sidebar from layout folder into french translation folder * fix: links in french translation sidebar * fix: update navbar french translation * update sidebar in docs folder * fix: link to image in index.html * fix: relative paths in README of intro to oss * fix: relative paths across chapters in intro to oss * fix: assets path, alt texts and indentation across chapters in intro to oss" * fix: image paths, alt texts and indentation across chapters in french translations * fix: relative paths across chapters in French translation * fix: update CONTRIBUTING to reflect new reorg * fix: update i18n guidelines to reflect new reorg * fix: update navbar in intro to oss * fix: update navbar in intro to oss french translation * fix: update navbar in homepage * fix: font color in dropdown menu and add padding to language navbar * fix: spacing in index.html * fix: add mergeNavbar to merge navbar to sidebar for smaller screen * fix: update navbars * fix: add styling for navbar * fix: add footer and fix links to edit page * feat: add pagination plugin and adjust the style * fix: remove links of next sections * fix: remoce link to next section in intro.md * fix: change alt text from Open Sauced to OpenSauced * fix: change image for issue-assign to reflect the content * fix: update sidebar * fix: indentation * Change title * Update wording on readme * Fix styling * Updated navbar to make it more navigable * Add styling to Readme * fix: remove chapter and file numbers from README * fix: remove numbers from file in sidebar * fix: remove number from 01-intro.md * fix: change ol to ul in intro.md * fix: remove number from file name in 02-what-is-open-source.md * fix: remove number from file name 03-why-open-source.md * fix: remove number from file name 04-tools-to-be-successful.md * fix: remove number from file name 05-how-to-contribute-to-open-source.md * fix: remove number from link in how-to-contribute-to-open-source.md and update wording * fix: remove number from file name 06-the-secret-sauce.md * fix: remove number from file name 07-types-of-contributions.md * fix: remove number from file name 08-additional-resources.md * fix: remove number from file name and link in conclusion.md * fix: remove number from file name 10-glossary.md * fix: remove number from link in README * fix: update CONTRIBUTING.md to reflect omitted numbers * fix: remove translations/fr/_layouts/sidebar.md from root * fix: remove 07-conclusion.md * fix: remove 09-glossaire.md * fix: rename files of French translation by omitting numbers * fix: update relative paths in sidebar of French translation * fix: link in introduction.md * fix: link in qu-est-ce-que-l-open-source.md * fix: link in pourquoi-open-source.md * fix: link in outils-pour-reussir.md * fix: link in comment-contribuer-à-l-open-source.md * fix: link in la-sauce-secrète.md * fix: link in différents-types-de-contributions.md * fix: link in ressources-additionnelles.md * fix: link in conclusion.md * fix: link in glossaire.md * fix: links in README French * fix: omit chapter numbers and fix heading levels in README French * fix: path to assets in comment-contribuer-à-l-open-source.md * fix: path to assets in la-sauce-secrète.md * fix: path to assets in outils-pour-reussir.md * fix: delete section suivante * fix: link to contributing file in French README * fix: links in French contributing * fix: remove @open-sauced/triage and update wording in contributing guidelines * fix: change @open-sauced/maintainers to docs in French contributing guidelines * fix: indentation in outils-pour-reussir.md * fix: add ul in la-sauce-secrète.md to reflect English version * fix: relative path on French sidebar to reflect English version * fix (CONTRIBUTING.md): update instruction to write relative path in sidebar * fix (CONTRIBUTING.md): update instruction to add new chapters to sidebar * fix: add new line after heading in README * fix: update wording in contributing.md * fix: change term in translation guidelines --------- Co-authored-by: BekahHW <rhawrot@gmail.com>
1 parent dc26ce6 commit 58145c6

Some content is hidden

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

53 files changed

+406
-406
lines changed

‎_layouts/navbar.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎_layouts/sidebar.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to OpenSauced Intro
22

3-
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.
3+
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.
44

55
## Recommended Communication Style
66

@@ -11,13 +11,13 @@ Contributions are always welcome, no matter how large or small. Before contribut
1111

1212
## Issues
1313

14-
When you contribute to the project for the first time, please consider checking the [bug](https://github.com/open-sauced/intro/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/intro/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels.
14+
- When you contribute to the project for the first time, please consider checking the [bug](https://github.com/open-sauced/intro/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/intro/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels.
1515

16-
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.
16+
- 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? You can create an issue to address it. But maintainers need to triage the issue before you can work on it. If you wish to work on the issue, please tag our `@open-sauced/community` maintainers in the comment to notify them.
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.
1919

20-
You can always ask for help in the `🍕opensauced-contributors-chat` channel on our community [Discord](https://discord.com/invite/U2peSNf23P) or GitHub Discussions if you get stuck while working on your changes or need clarification.
20+
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

2222
## Getting Started
2323

@@ -43,7 +43,7 @@ You can always ask for help in the `🍕opensauced-contributors-chat` channel on
4343
```
4444

4545
Replace "YOUR-BRANCH-NAME" with a descriptive name for your branch — for example, `feat/add-submit-button`.
46-
46+
4747
5. Run the project.
4848

4949
### Running the Project Locally
@@ -72,7 +72,7 @@ We recommend one of these two methods for running the project on your local mach
7272
3. **Run the project**.
7373

7474
```bash
75-
docsify serve
75+
docsify serve docs
7676
```
7777

7878
This command will start a local development server, and you can access the project in your web browser at `http://localhost:3000`.
@@ -108,7 +108,7 @@ Live Server extension allows you to launch a local development server and previe
108108

109109
4. **Launch the Live Server**.
110110

111-
Click the "Go Live" button in the bottom-right corner of the VS Code window. It will open the project in a new tab on your browser at a local address.
111+
Click the "Go Live" button in the bottom-right corner of the VS Code window. It will open a new tab on your browser at a local address. Then, click the "docs" folder to see the project in live mode.
112112

113113
5. **Make and test changes**.
114114

@@ -124,7 +124,7 @@ The contents of this course are written in [Markdown](https://www.markdownguide.
124124

125125
### Adding Definitions to the Glossary
126126

127-
If you add definitions to the [Glossary](10-glossary.md) chapter, ensure the definitions are added in **alphabetical order**.
127+
If you add definitions to the [Glossary](../intro-to-oss/glossary.md) chapter, ensure the definitions are added in **alphabetical order**.
128128

129129
### Adding a New Section to a Chapter
130130

@@ -142,33 +142,21 @@ Follow these steps to add a new chapter to our course:
142142

143143
1. **Create a new Markdown file**.
144144

145-
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.
145+
Create a new Markdown (`.md`) file in the course directory 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.
146146

147147
> **NOTE**: Be sure to follow naming conventions. Notice that file names are not capitalized, and there are hyphens in place of spaces between words.
148148
149-
2. **Determine the chapter's number**.
150-
151-
We have specific conventions for numbering file names to maintain a consistent structure. In this project, the numbers in the file name represent chapters—for example, `01-intro`, `02-what-is-open-source`, `03-why-open-source`, etc.
152-
153-
Consider where the new chapter you'll work on logically falls in the course.
154-
155-
If you're not sure, please comment on the issue and tag the `@open-sauced/community` maintainers to ask for help.
156-
157-
3. **Write content**.
149+
2. **Write content**.
158150

159151
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.
160152

161153
> **Note**: There should only be **one** `heading 1` in each file.
162154
163-
4. **Ensure there are no duplicate chapter numbers, and they should be in order**.
164-
165-
There should only be one number for each chapter (no duplication), and the numbers must be in order to make the course flow. You need to rename other files that follow your new file by changing the chapter number accordingly.
166-
167-
5. **Test your changes**.
155+
3. **Test your changes**.
168156

169157
Before finalizing your new chapter, you should test your changes locally. You can build or render the project to ensure your new chapter appears as expected within the course structure.
170158

171-
6. **Update the sidebar**.
159+
4. **Update the sidebar**.
172160

173161
After you add a new chapter, you must also add it to the sidebar for the users to discover the content.
174162

@@ -178,28 +166,24 @@ The sidebar in our course serves as a navigation menu. So, when you add a new ch
178166

179167
Follow these steps to add new chapters to the sidebar:
180168

181-
1. Navigate to `_layouts/sidebar.js`.
169+
1. Open the `_sidebar.md` file in the course directory.
182170
2. **Add the new chapter link**.
183171

184-
- Insert a new line in the list based on your chapter's number. For example, if your chapter number is `07`, insert this new line right after `06`.
172+
- Insert your new chapter in the list. If you're unsure where best to put it, you can comment on the issue and tag the `@open-sauced/docs` maintainers to ask for help.
185173
- Use the below format to add the link to the new chapter:
186174

187175
```markdown
188-
- [Intro](https://github.com/01-intro.md)
176+
- [Intro](intro.md)
189177
```
190178

191179
- Replace `Intro` with the title of your new chapter. _Be sure to capitalize the title_.
192-
- Replace `/01-intro.md` with the relative path to the Markdown file of your new chapter.
193-
194-
3. **Ensure the chapter's numbers are in order**.
195-
196-
The chapter's numbers should be in order. So, you must change the chapter numbers in the relative paths that follow the new chapter.
180+
- Replace `intro.md` with the name of the Markdown file of your new chapter.
197181

198-
4. **Create a pull request**.
182+
3. **Create a pull request**.
199183

200184
Once you have created the new chapter and verified that it meets our project's requirements, you can submit your contribution by creating a pull request.
201185

202-
5. **Review and feedback**.
186+
4. **Review and feedback**.
203187

204188
Wait for maintainers to review your pull request, and be prepared to receive feedback from them or collaborators. Make changes if necessary to refine your contribution.
205189

LICENSE.txt renamed to docs/LICENSE.txt

File renamed without changes.

‎docs/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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>
4+
</div>
5+
6+
Welcome to the Open Source Education Path with OpenSauced!
7+
8+
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.
9+
10+
At OpenSauced, we aim to empower contributors, maintainers, and teams in open source, not only through [our product](https://opensauced.pizza/) but also through sharing knowledge. For that reason, we created courses designed to guide you into the open source world as a contributor or as a potential maintainer.
11+
12+
## **Courses**
13+
14+
### Intro to Open Source Course
15+
16+
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.
17+
18+
**Head to our [Intro to Open Source](./intro-to-oss/) course to start your learning journey!**
19+
20+
### Becoming a Maintainer — Coming Soon!
21+
22+
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.
23+
24+
## **Contributing to Our Courses**
25+
26+
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.
27+
28+
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](/i18n-guidelines.md).
29+
30+
## **Community**
31+
32+
Do you have questions or need help? Join our community [Discord](https://discord.gg/U2peSNf23P).
33+
34+
## **⚖️ LICENSE**
35+
36+
[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/)
37+
38+
<footer>
39+
<a href="https://github.com/open-sauced/intro/blob/main/docs/README.md">✏️ Edit this page</a>
40+
</footer>

images/cli-tool.gif renamed to docs/_assets/gifs/cli-tool.gif

File renamed without changes.

‎docs/_assets/images/issue-assign.png‎

7.57 KB
Loading

images/new-repo.png renamed to docs/_assets/images/new-repo.png

File renamed without changes.

images/opensauced-explore.png renamed to docs/_assets/images/opensauced-explore.png

File renamed without changes.

images/opensauced-highlights.png renamed to docs/_assets/images/opensauced-highlights.png

File renamed without changes.

0 commit comments

Comments
 (0)