Skip to content

Commit 48e5f10

Browse files
authored
fix: relative paths in the project (OpenSource-Communities#162)
1 parent 58145c6 commit 48e5f10

20 files changed

+81
-70
lines changed

docs/CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,18 @@ Running the project locally is essential to see your changes in real-time and te
5252

5353
We recommend one of these two methods for running the project on your local machine:
5454

55-
1. Using the [Docsify CLI](https://docsify.js.org/#/).
55+
1. Using the [docsify CLI](https://docsify.js.org/#/).
5656
2. Leveraging Visual Studio Code's [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) extension.
5757

58-
#### Method 1: Using the Docsify CLI
58+
#### Method 1: Using the docsify CLI
5959

6060
1. **Install Node.js**.
6161

6262
You can download it from the official [Node.js website](https://nodejs.org/).
6363

64-
2. **Install Docsify globally**.
64+
2. **Install docsify globally**.
6565

66-
It's highly recommended to install Docsify globally. In your terminal, run the following command:
66+
It's highly recommended to install docsify globally. In your terminal, run the following command:
6767

6868
```bash
6969
npm install -g docsify-cli
@@ -120,11 +120,11 @@ 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 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.
124124

125125
### Adding Definitions to the Glossary
126126

127-
If you add definitions to the [Glossary](../intro-to-oss/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

@@ -249,7 +249,7 @@ Create links using square brackets (`[]`) for the link text and parentheses (`()
249249
Embed images using an exclamation mark (`!`), followed by square brackets (`[]`) for the alt text, and parentheses (`()`) for the image URL.
250250

251251
```markdown
252-
![OpenSauced Highlights](https://github.com/open-sauced/intro/blob/main/images/opensauced-highlights.png)
252+
![Create new repository on GitHub](../_assets/images/new-repo.png)
253253
```
254254

255255
#### 6. Blockquotes
@@ -280,4 +280,4 @@ git pull
280280

281281
## Translating the Intro to Open Source Course
282282

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

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ At OpenSauced, we aim to empower contributors, maintainers, and teams in open so
1515

1616
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.
1717

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

2020
### Becoming a Maintainer — Coming Soon!
2121

2222
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.
2323

2424
## **Contributing to Our Courses**
2525

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.
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.
2727

28-
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](/i18n-guidelines.md).
28+
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).
2929

3030
## **Community**
3131

docs/i18n-guidelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Welcome to our i18n Guidelines! We appreciate your interest in translating our I
44

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

7-
- [English](/intro-to-oss/)
8-
- [French](/intro-to-oss/translations/fr/README)
7+
- [English](./intro-to-oss/README.md)
8+
- [French](./intro-to-oss/translations/fr/README.md)
99
- Brazilian Portuguese — work in progress
1010

1111
## How can I Contribute?
@@ -25,7 +25,7 @@ Official translations start as a post on our [GitHub Discussions](https://github
2525

2626
#### 2. Community Translations
2727

28-
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.
28+
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.
2929

3030
If you're interested in translating our Intro to Open Source 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 that you can find in the root directory.
3131

@@ -37,7 +37,7 @@ If you are familiar with the translated language(s), you can help us review the
3737

3838
## Adding Translations
3939

40-
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:
40+
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:
4141

4242
1. **Identify target languages**.
4343

docs/intro-to-oss/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,48 +20,54 @@ For translations in other languages that are maintained by our community, please
2020

2121
The course is divided into chapters, each covering a different aspect of open source:
2222

23-
### What is Open Source?
23+
### [Intro](intro.md)
24+
25+
This chapter sets the stage for your open source journey and discusses prerequisites, objectives, and expectations.
26+
27+
### [What is Open Source?](what-is-open-source.md)
2428

2529
This chapter provides an introduction to open source, its history, and its importance in today's software development landscape.
2630

27-
### Why Open Source?
31+
### [Why Open Source?](why-open-source.md)
2832

2933
In this chapter, you'll learn about the benefits of open source software, such as increased collaboration, faster development, and improved quality.
3034

31-
### Tools to be Successful
35+
### [Tools to be Successful](tools-to-be-successful.md)
3236

3337
Discover the key tools and platforms necessary for a successful journey in open source development. From Git and GitHub for version control and collaboration to CodeSee for code visualization and VS Code as your code editor, this chapter provides an overview of how to leverage these essential tools.
3438

35-
### How to Contribute to Open Source
39+
### [How to Contribute to Open Source](how-to-contribute-to-open-source.md)
3640

3741
This chapter covers finding projects to work on, submitting contributions, onboarding contributors to new projects, and the outcomes after submitting contributions. Tips for finding projects include browsing GitHub and GitLab, following personal interests, joining open source communities, and utilizing platforms like OpenSauced.
3842

39-
### The Secret Sauce
43+
### [The Secret Sauce](the-secret-sauce.md)
4044

4145
This chapter focuses on providing lesser-known strategies and tips for making a lasting impact in the open source community. This chapter provides strategies for finding issues, gaining traction in your open source journey, and leveraging OpenSauced to build your open source resume.
4246

43-
### Types of Contributions
47+
### [Types of Open Source Contributions](types-of-contributions.md)
4448

4549
This chapter explains the non-coding and coding types of contributions involved with open source projects.
4650

4751
### Additional Information
4852

4953
As this is the beginning of your open source journey, we've also provided additional information in these chapters:
5054

51-
- [Glossary](./glossary.md): A glossary of common terms and definitions used in open source.
52-
- [Additional Resources](./additional-resources.md): A list of resources for further learning about open source, including blog posts, tutorials, and guides.
55+
- [Glossary](glossary.md): A glossary of common terms and definitions used in open source.
56+
- [Additional Resources](additional-resources.md): A list of resources for further learning about open source, including blog posts, tutorials, and guides.
5357

5458
## Getting Started
5559

56-
To start the course, navigate to the [`intro` file](/intro-to-oss/intro.md) in the repository or visit the [Intro to Open Source with OpenSauced website](https://intro.opensauced.pizza/) and start reading! Each chapter builds on the previous one, so we recommend reading them in order.
60+
If you are taking this course on our GitHub repository, navigate to the [`intro.md` file](intro.md) to start the course. Alternatively, visit the [Intro to Open Source with OpenSauced on the website](https://intro.opensauced.pizza/#/intro-to-oss/) and start reading!
61+
62+
Each chapter builds on the previous one, so we recommend reading them in order.
5763

5864
As you work through the course, we encourage you to experiment with the tools and concepts covered in each chapter. The best way to learn is by doing, so try contributing to an open source project or building your project from scratch!
5965

6066
## Building Your Open Source Resume
6167

6268
One of the unique features of this course is that it guides you to build your open source resume using OpenSauced. OpenSauced is a platform that helps you track and showcase your open source contributions, making it easier to get noticed by potential employers and collaborators.
6369

64-
To learn more about using OpenSauced to build your open source resume, check out the [Building Your Open Source Resume](/intro-to-oss/the-secret-sauce.md#building-your-open-source-resume) section in [The Secret Sauce](/intro-to-oss/the-secret-sauce.md) chapter.
70+
To learn more about using OpenSauced to build your open source resume, check out the "[Building Your Open Source Resume](the-secret-sauce.md#building-your-open-source-resume)" section in "The Secret Sauce" chapter.
6571

6672
---
6773

docs/intro-to-oss/_sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
- [How to Contribute to Open Source](how-to-contribute-to-open-source.md)
77
- [The Secret Sauce](the-secret-sauce.md)
88
- [Types of Open Source Contributions](types-of-contributions.md)
9-
- [Additional Resources](additional-resources.md)
109
- [Conclusion](conclusion.md)
10+
- [Additional Resources](additional-resources.md)
1111
- [Glossary](glossary.md)

docs/intro-to-oss/conclusion.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@ As we wrap up this course on getting started with open source, let's recap the k
66

77
Throughout this course, we've covered a range of topics designed to help you understand and navigate the world of open source:
88

9-
1. **What is open source?**: We discussed the definition of open source, its history, and the core principles that guide the open source movement.
9+
- **[What is Open Source?](what-is-open-source.md)**: We discussed the definition of open source, its history, and the core principles that guide the open source movement.
1010

11-
2. **Why open source?**: We explored the benefits of engaging with open source projects, including access to knowledge, community, and skills development.
11+
- **[Why Open Source?](why-open-source.md)**: We explored the benefits of engaging with open source projects, including access to knowledge, community, and skills development.
1212

13-
3. **Tools to be successful**: We introduced essential tools and platforms for open source contributors, such as GitHub, Git, CodeSee, Visual Studio Code, and Discord.
13+
- **[Tools to be Successful](tools-to-be-successful.md)**: We introduced essential tools and platforms for open source contributors, such as GitHub, Git, CodeSee, Visual Studio Code, and Discord.
1414

15-
4. **How to contribute to open source**: We discussed the process of finding projects to work on, submitting contributions, onboarding to new projects, and what happens after your contribution is submitted.
15+
- **[How to Contribute to Open Source](how-to-contribute-to-open-source.md)**: We discussed the process of finding projects to work on, submitting contributions, onboarding to new projects, and what happens after your contribution is submitted.
1616

17-
5. **The Secret Sauce**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
17+
- **[The Secret Sauce](the-secret-sauce.md)**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
18+
19+
- **[Types of Open Source Contributions](types-of-contributions.md)**: We shared the coding and non-coding types of contributions in open source, along with examples.
1820

1921
By understanding these concepts and applying the strategies we've discussed, you'll be well-equipped to embark on a successful open source journey.
2022

21-
## What's next?
23+
## What's Next?
2224

2325
With the knowledge and tools you've gained from this course, you're ready to dive into the world of open source and start making meaningful contributions. Here are some next steps to help you continue your open source journey:
2426

@@ -34,7 +36,7 @@ With the knowledge and tools you've gained from this course, you're ready to div
3436

3537
6. **Share your experiences**: Document your open source journey by writing blog posts, creating tutorials, or giving presentations. This will not only help others learn from your experiences but also establish you as a thought leader in the open source community.
3638

37-
7. **Continue learning**: Open source is a dynamic and ever-evolving field. Stay current with the latest tools, techniques, and best practices by attending workshops, taking online courses, and reading articles and books on open source development. We've included an [additional resources section](./additional-resources.md) for more information.
39+
7. **Continue learning**: Open source is a dynamic and ever-evolving field. Stay current with the latest tools, techniques, and best practices by attending workshops, taking online courses, and reading articles and books on open source development. We've included an [additional resources section](additional-resources.md) for more information.
3840

3941
In conclusion, embarking on an open source journey is a rewarding and enriching experience that can help you develop new skills, connect with like-minded individuals, and make a lasting impact on the projects you work on. With the knowledge and tools you've gained from this course, you're well-prepared to take on the exciting challenges and opportunities that await you in the open source world. So go forth and start contributing – the open source community eagerly awaits your participation!
4042

docs/intro-to-oss/how-to-contribute-to-open-source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ You'll need to have these tools donwloaded and installed on your local machine:
177177

178178
Congratulations on your first contribution! 🎉
179179

180-
?> If you're ready for your next contribution, head on over to the [pizza-verse repo](https://github.com/open-sauced/pizza-verse) and follow the contribution guidelines for your next contribution. Once you're done, head on over to "[The Secret Sauce](./the-secret-sauce.md)" chapter in this course.
180+
?> If you're ready for your next contribution, check out the [pizza-verse repository](https://github.com/open-sauced/pizza-verse) and follow the contribution guidelines.
181181
182182
## Keeping Branches Up to Date
183183
@@ -283,7 +283,7 @@ Before resolving merge conflicts, you must first [update your branches](#updatin
283283

284284
<hr>
285285

286-
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the next chapter, we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
286+
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the [next chapter](the-secret-sauce.md), we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
287287

288288
<footer>
289289
<a href="https://github.com/open-sauced/intro/blob/main/docs/intro-to-oss/how-to-contribute-to-open-source.md">✏️ Edit this page</a>

0 commit comments

Comments
 (0)