diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 0b8c3add..310980e6 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,4 +1,4 @@ -[![OpenSauced Logo](../_assets/images/logo-on-dark.png)](https://opensauced.pizza/) +[![OpenSauced Logo](_assets/images/logo-on-dark.png)](https://opensauced.pizza/) - [Open Source Education Path](/) diff --git a/docs/community-translations.md b/docs/community-translations.md index 68583e67..44fa224a 100644 --- a/docs/community-translations.md +++ b/docs/community-translations.md @@ -8,6 +8,7 @@ We are grateful for the contributions of the community in translating our course +- [Arabic](https://github.com/dvmhmdsd/open-sauced-translation) - maintain by [dvmhmdsd - Mohamed Saad](https://github.com/dvmhmdsd) ## Becoming a Maintainer Course diff --git a/docs/index.html b/docs/index.html index 29f63644..c229a6cc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,90 +1,115 @@ - - - OpenSauced - - - - - - - - -
- - - - - - - - + + + OpenSauced + + + + + + + + +
+ + + + + + + + diff --git a/docs/intro-to-oss/_navbar.md b/docs/intro-to-oss/_navbar.md index f2926a21..0cb73416 100644 --- a/docs/intro-to-oss/_navbar.md +++ b/docs/intro-to-oss/_navbar.md @@ -6,3 +6,4 @@ - Languages - [:us: English](/intro-to-oss/) - [:fr: French](/intro-to-oss/translations/fr/) + - [:egypt: Arabic](/intro-to-oss/translations/ar/) diff --git a/docs/intro-to-oss/translations/ar/README.md b/docs/intro-to-oss/translations/ar/README.md new file mode 100644 index 00000000..645a12bd --- /dev/null +++ b/docs/intro-to-oss/translations/ar/README.md @@ -0,0 +1,91 @@ +
+
+

Intro to Open Source with OpenSauced +

+
+
+ +Welcome to the Intro to Open Source Course with OpenSauced! This course is designed to provide you with an introduction to open source and guide you through the process of contributing to open source projects. + +## Language Support + +Like pizza, open source is meant to be shared with everyone. We provide and maintain translations in languages below as our official translations: + +- [French](./translations/fr/README.md) + +For translations in other languages that are maintained by our community, please go to the [Community Translations](../community-translations.md) section. + +## Course Overview + +The course is divided into chapters, each covering a different aspect of open source: + +### [Intro](intro.md) + +This chapter sets the stage for your open source journey and discusses prerequisites, objectives, and expectations. + +### [What is Open Source?](what-is-open-source.md) + +This chapter provides an introduction to open source, its history, and its importance in today's software development landscape. + +### [Why Open Source?](why-open-source.md) + +In this chapter, you'll learn about the benefits of open source software, such as increased collaboration, faster development, and improved quality. + +### [Tools to be Successful](tools-to-be-successful.md) + +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. + +### [How to Contribute to Open Source](how-to-contribute-to-open-source.md) + +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. + +### [The Secret Sauce](the-secret-sauce.md) + +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. + +### [Types of Open Source Contributions](types-of-contributions.md) + +This chapter explains the non-coding and coding types of contributions involved with open source projects. + +### Additional Information + +As this is the beginning of your open source journey, we've also provided additional information in these chapters: + +- [Glossary](glossary.md): A glossary of common terms and definitions used in open source. +- [Additional Resources](additional-resources.md): A list of resources for further learning about open source, including blog posts, tutorials, and guides. + +## Getting Started + +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! + +?> **Tip:** Each chapter builds on the previous one, so we recommend reading them in order. + +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! + +## Building Your Open Source Resume + +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. + +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. + +--- + +We hope you find this course informative and useful! If you have any questions or feedback, please don't hesitate to open an issue or reach out to us in the [OpenSauced community Discord](https://discord.com/invite/U2peSNf23P). + +Happy learning and contributing! + +--- + +## 🤝 Contributing to this 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. + +If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](../i18n-guidelines.md). + +## ⚖️ LICENSE + +[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/) + + diff --git a/docs/intro-to-oss/translations/ar/_navbar.md b/docs/intro-to-oss/translations/ar/_navbar.md new file mode 100644 index 00000000..d0ca3e4d --- /dev/null +++ b/docs/intro-to-oss/translations/ar/_navbar.md @@ -0,0 +1,8 @@ +- [الصفحة الرئيسية](../../README.md) +- الكورسات المتاحة + - [مقدمة إلي الopen source](/intro-to-oss/README.md) + - [كيف تصبح مشرفا](/becoming-a-maintainer/README.md) +- اللغات + - [:us: الإنجليزية](/intro-to-oss/) + - [:fr: الفرنسية](/intro-to-oss/translations/fr/) + - [:egypt: العربية](/intro-to-oss/translations/ar/) diff --git a/docs/intro-to-oss/translations/ar/_sidebar.md b/docs/intro-to-oss/translations/ar/_sidebar.md new file mode 100644 index 00000000..77b87990 --- /dev/null +++ b/docs/intro-to-oss/translations/ar/_sidebar.md @@ -0,0 +1,13 @@ +[![صورة OpenSauced](../../../_assets/images/logo-on-dark.png)](https://opensauced.pizza/) + +- Intro to Open Source + - [Introduction to Open Source](intro.md) + - [What is Open Source?](what-is-open-source.md) + - [Why Open Source?](why-open-source.md) + - [Tools to be Successful](tools-to-be-successful.md) + - [How to Contribute to Open Source](how-to-contribute-to-open-source.md) + - [The Secret Sauce](the-secret-sauce.md) + - [Types of Open Source Contributions](types-of-contributions.md) + - [Conclusion](conclusion.md) + - [Additional Resources](additional-resources.md) + - [Glossary](glossary.md) diff --git a/docs/intro-to-oss/translations/ar/intro.md b/docs/intro-to-oss/translations/ar/intro.md new file mode 100644 index 00000000..b216dc3d --- /dev/null +++ b/docs/intro-to-oss/translations/ar/intro.md @@ -0,0 +1,59 @@ +# Introduction + +Welcome to the "Intro to Open Source with OpenSauced" course! This comprehensive course will guide you through the fascinating world of open source and help you become an active contributor. By the end of this course, you should have a solid understanding of how to find, join, and contribute to open source projects, as well as how to develop your open source resume. But first, let's set the stage by discussing the prerequisites, objectives, and expectations for this course. + +## Prerequisites + +Before diving into the world of open source, it's essential to have a basic understanding of programming concepts and some experience working with code. While the course will provide examples and demos, you'll get the most out of the material if you have some prior knowledge. + +Additionally, this course assumes that you are familiar with Git and GitHub. Git is a widely-used version control system, and GitHub is a popular platform for hosting and collaborating on Git repositories. If you're not already familiar with Git and GitHub, we recommend taking some time to learn the basics before starting this course. + +## Objectives + +Throughout this course, our primary objectives are to help you: + +1. **Understand open source and its benefits**: We'll explore the concept of open source, its history, and the numerous advantages of contributing to open source projects. +2. **Learn how to find open source projects**: Discovering projects that align with your interests and skills is crucial for a rewarding open source experience. We'll introduce you to tools and techniques for finding projects to contribute to. +3. **Master the tools and processes for contributing**: We'll provide an overview of the essential tools and processes required for successful open source collaboration, such as version control, code review, and communication platforms. +4. **Gain practical experience**: By following along with examples and demos, you'll have the opportunity to practice your skills and gain confidence in your ability to contribute to open source projects. +5. **Develop your open source resume**: Showcasing your open source contributions is vital for building your reputation in the community and demonstrating your expertise to potential employers or clients. We'll discuss strategies for developing and maintaining your open source resume. + +## Expectations + +This course is designed to provide you with a solid foundation in open source collaboration. While we'll cover a range of topics and provide examples, demos, and opportunities for hands-on practice, it's essential to have realistic expectations about what you can achieve during the course. + +1. **Practice is crucial**: Learning about open source is just the beginning; to truly develop your skills and become a proficient contributor, you'll need to practice consistently. Keep in mind that the more you contribute to open source projects, the more you'll learn and grow as a developer. + +2. **Patience is key**: Becoming proficient in open source collaboration takes time and effort. Don't be discouraged if you encounter challenges along the way; remember that every contribution, no matter how small, is valuable and helps improve the project. + +3. **Engagement with the community**: Open source is more than just code; it's about the people who collaborate and contribute to projects. Engage with the community by asking questions, sharing your knowledge, and supporting others. Building relationships with other contributors will enhance your open source experience and help you grow as a developer. + +4. **Continuous learning**: Open source is a rapidly evolving field, with new projects, tools, and technologies emerging all the time. Stay curious and open to learning, and take advantage of resources like documentation, tutorials, and community forums to expand your knowledge and stay up-to-date with the latest developments. + +5. **Developing a growth mindset**: Embrace the challenges and opportunities that come with open source collaboration. Adopt a growth mindset, which focuses on learning, improvement, and resilience. By viewing obstacles as opportunities for growth, you'll be better equipped to navigate the complex world of open source and achieve success in your contributions. + +## Course Structure + +This course is divided into several chapters, each designed to cover a specific aspect of open source collaboration: + +- **[What is Open Source?](what-is-open-source.md):** In this chapter, we'll explore the definition of open source and its history, providing you with a solid foundation for understanding the context of open source collaboration. +- **[Why Open Source?](what-is-open-source.md):** We'll delve into the benefits of open source, including access to knowledge, community, and skills development. +- **[Tools to be Successful](tools-to-be-successful.md):** This chapter will introduce you to the essential tools for successful open source collaboration, including GitHub, Git, VS Code, and Discord. +- **[How to Contribute to Open Source](how-to-contribute-to-open-source.md):** In this chapter, we'll discuss the process of finding projects to work on, submitting contributions, onboarding in a new project, and what to expect after your contribution has been submitted. +- **[The Secret Sauce](the-secret-sauce.md):** This chapter will reveal the strategies and techniques for getting started, gaining traction in your contributions, and developing your open source resume. +- **[Types of Open Source Contributions](types-of-contributions.md):** This chapter will discuss the types of open source contributions. +- **[Conclusion](conclusion.md):** We'll wrap up the course with key takeaways and discuss the next steps in your open source journey. + +Throughout this course, we'll provide examples and demos to help illustrate key concepts and provide hands-on opportunities for practice. When possible, we'll feature real-world open source projects and tools, such as [OpenSauced](https://opensauced.pizza/), to demonstrate how to apply the skills you've learned. + +Please note that while these examples and demos are designed to provide guidance and inspiration, your own open source journey may differ depending on your interests, skills, and chosen projects. + +Use the examples and demos as a starting point, but don't be afraid to explore other projects, tools, and resources as you continue to learn and grow. + +## Let's Get Started 🚀 + +Now that we've set the stage, it's time to embark on your open source journey! In the [next chapter](what-is-open-source.md), we'll dive into the definition of open source and explore its history, laying the groundwork for a deeper understanding of open source collaboration. Let's get started! + + diff --git a/docs/intro-to-oss/translations/fr/_navbar.md b/docs/intro-to-oss/translations/fr/_navbar.md index db0874a8..29fde46c 100644 --- a/docs/intro-to-oss/translations/fr/_navbar.md +++ b/docs/intro-to-oss/translations/fr/_navbar.md @@ -4,3 +4,4 @@ - Languages - [:us: Anglais](/intro-to-oss/) - [:fr: Français](/intro-to-oss/translations/fr/) + - [:ar: Arabe](/intro-to-oss/translations/ar/) diff --git a/docs/styles/custom.css b/docs/styles/custom.css index f9f32ca3..56546768 100644 --- a/docs/styles/custom.css +++ b/docs/styles/custom.css @@ -1,25 +1,92 @@ a:hover { - text-decoration: underline; + text-decoration: underline; } .token.property { - color: #205D3B; + color: #205d3b; } .token.punctuation { - color: #205D3B; + color: #205d3b; } .markdown-section p.tip code { - background-color: transparent; + background-color: transparent; } .app-nav li ul { - background: #FFFDFA; - color: #11181C; - padding-right: 1.5em; + background: #fffdfa; + color: #11181c; + padding-right: 1.5em; } section.cover p { - padding: 0 5em; -} \ No newline at end of file + padding: 0 5em; +} + +/* Arabic translation style */ + +.rtl-lang .app-nav { + left: 0; + text-align: left; + right: unset; + margin: 25px 0 0 30px; +} + +.rtl-lang .sidebar { + right: 0; + left: unset; + text-align: right; + border-left: 1px solid var(--borderColor); + border-right: unset; + overflow-y: unset; +} + +.rtl-lang .app-nav li ul { + left: -15px; + right: unset; + text-align: right; + padding-left: 1.5em; + padding-right: unset; +} + +.rtl-lang .sidebar ul { + margin: 0 15px 0 0; +} + +.rtl-lang .search input { + margin: 30px auto +} + +.rtl-lang .sidebar ul li.active>a { + border-left: 2px solid; + border-right: unset; +} + +.rtl-lang .app-sub-sidebar li:before { + padding-left: 4px; + float: right; +} + +.rtl-lang .sidebar-toggle { + right: 0; + left: unset; +} + +body.close.rtl-lang .sidebar { + transform: translateX(300px); +} + +.rtl-lang .content { + right: 300px; + left: unset; +} + +body.close .content { + right: 0; +} + +.rtl-lang #docsify-darklight-theme { + left: -20px; + right: unset; +}