Skip to content

Commit

Permalink
Merge pull request #75 from CBID2/add-edit-this-page-buttons
Browse files Browse the repository at this point in the history
feat: add "Edit this Page" link
  • Loading branch information
adiati98 authored Oct 30, 2023
2 parents efead39 + 71813f3 commit f7a9056
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 2 deletions.
4 changes: 4 additions & 0 deletions 01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,7 @@ Use the examples and demos as a starting point, but don't be afraid to explore o
Now that we've set the stage, it's time to embark on your open source journey! In the next chapter, 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!

[Next Section ->](02-what-is-open-source.md)

<a href="https://github.com/open-sauced/intro/edit/main/01-intro.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 02-what-is-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,7 @@ The growing popularity of open source has also led to a thriving ecosystem of co
In the next chapter, we'll explore the many benefits of contributing to open source projects and discuss how open source collaboration can help you access knowledge, connect with a community, and develop valuable skills.

[Next Section ->](03-why-open-source.md)

<a href="https://github.com/open-sauced/intro/edit/main/02-what-is-open-source.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 03-why-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,7 @@ In addition to the above-mentioned benefits, contributing to open source project
In the next chapter, we'll discuss the essential tools and resources you'll need to be successful in your open source journey, including GitHub, Git, CodeSee, VS Code, and Discord. By familiarizing yourself with these tools, you'll be better equipped to collaborate with others, manage your projects, and contribute effectively to open source projects.

[Next Section ->](04-tools-to-be-successful.md)

<a href="https://github.com/open-sauced/intro/edit/main/03-why-open-source.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 04-tools-to-be-successful.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,7 @@ To get started with Discord, visit the official website (https://discord.com/) a
By familiarizing yourself with these tools and platforms, you'll be equipped to collaborate effectively, manage your projects, and contribute to open source projects. In the next chapter, we'll discuss how to contribute to open source projects, including finding projects to work on, submitting contributions, and what happens after your contribution is accepted.

[Next Section ->](05-how-to-contribute-to-open-source.md)

<a href= "https://github.com/open-sauced/intro/edit/main/04-tools-to-be-successful.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 05-how-to-contribute-to-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,7 @@ Congratulations! Your work is now part of the project, and you've made a valuabl
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.

[Next Section ->](06-the-secret-sauce.md)

<a href="https://github.com/open-sauced/intro/blob/main/05-how-to-contribute-to-open-source.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 06-the-secret-sauce.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,7 @@ By leveraging OpenSauced to track your open source contributions and develop you
In conclusion, getting started with open source contributions and making a lasting impact on the projects you work on requires a combination of technical skills, collaboration, and persistence. By focusing on open issues, gaining traction in your contributions, and leveraging tools like OpenSauced, you'll be well on your way to a successful and fulfilling open source journey.

[Final Section ->](07-types-of-contributions.md)

<a href= "https://github.com/open-sauced/intro/edit/main/06-the-secret-sauce.md">
✏️ Edit this page
</a>
3 changes: 3 additions & 0 deletions 07-types-of-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,6 @@ Here are some examples of contributions you can make to a project with your codi

[Next Section ->](08-additional-resources.md)

<a href="https://github.com/open-sauced/intro/edit/main/07-types-of-contributions.md">
✏️ Edit this page
</a>
6 changes: 5 additions & 1 deletion 08-additional-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@ Congratulations on your journey into open source! Here are some resources for fu
-[How to Write a Good Issue: Tips for Effective Communication in Open Source](https://dev.to/opensauced/how-to-write-a-good-issue-tips-for-effective-communication-in-open-source-5443)
- [Good first issues don't exist](https://opensauced.pizza/blog/good-first-issues-dont-exist)

[Next Section ->](09-conclusion.md)
[Next Section ->](09-conclusion.md)

<a href="https://github.com/open-sauced/intro/edit/main/08-additional-resources.md">
✏️ Edit this page
</a>
6 changes: 5 additions & 1 deletion 09-conclusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,8 @@ With the knowledge and tools you've gained from this course, you're ready to div

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!

[Next Section ->](10-glossary.md)
[Next Section ->](10-glossary.md)

<a href="https://github.com/open-sauced/intro/edit/main/09-conclusion.md">
✏️ Edit this page
</a>
15 changes: 15 additions & 0 deletions 10-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Markdown is a lightweight markup language commonly used for creating formatted t

Merging is the process of combining changes from one branch into another. When a pull request is accepted and merged, the changes made in the pull request become part of the main codebase.

## Docs
This is an abbreviation for the word documentation, a piece of text that provides information on how to contribute to OSS projects and expectations for contributors. Markdown, a text-based coding language is often used to create these forms of content. Want to see one in action? Check out the [Style Guide in our Pizza Verse repo](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md)!
## Onboarding

Onboarding documentation helps new team members or collaborators quickly become familiar with a project's structure, goals, and processes.
Expand Down Expand Up @@ -69,3 +71,16 @@ A repository is a central location where code is stored and managed. In open sou
## Style Guide

A style guide is a set of rules and conventions that define the preferred formatting, writing style, and visual elements used in documentation and other content. This helps maintain consistency and clarity across documents, making them easier to read and understand.


## Onboarding

Onboarding documentation helps new team members or collaborators quickly become familiar with a project's structure, goals, and processes.

## Release Notes

Release notes are documents that detail changes, enhancements, bug fixes, and new features in each software release. They inform users and stakeholders about what to expect in a new version of the software.

<a href="https://github.com/open-sauced/intro/edit/main/10-glossary.md">
✏️ Edit this page
</a>
4 changes: 4 additions & 0 deletions 11-understanding-merge-conflicts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ Manually edit the file to resolve the conflict. Decide which changes to keep or
9. Verify the Merge: Verify that the merge conflict has been successfully resolved by checking the remote repository or using Git tools.

VS Code and GitLens simplify the conflict resolution process by providing a visual interface for managing merge conflicts. This allows you to easily navigate through conflicting files and review changes, making the process more intuitive.

<a href="https://github.com/open-sauced/intro/edit/main/11-understanding-merge-conflicts.md">
✏️ Edit this page
</a>

0 comments on commit f7a9056

Please sign in to comment.