Skip to content

Commit

Permalink
feat: Reorganize docs (#201)
Browse files Browse the repository at this point in the history
* Add tools section and pizza CLI

* Add features section

* Add lists to features

* Small fixes

* Copy updates

* Update links to go to the right place

* Move technical into contributing folder

* Rename Pizza-cli

* Move maintainers guide to contributing

* Rename maintainers to opensauced-packages

* Update the sidebar to reflect file moves and name changes

* Change a couple folders to collapsed

* Remove section about not resolving merge conflicts in GH editor

* Update image paths

* Update image path in pr-description

* Remove repetitive file

* Remove deleted file from sidebar

* Update path for refactoring and testing

* Update paths for viewing insights and invitations

* Change twitter to X

* Add link to yt demos

* Change title to learN

* Remove setting up a new repo

* Remove deleted resource from sidebar

* Add a link to intro course in learn section

* Remove extra apostrophe
  • Loading branch information
BekahHW authored Nov 6, 2023
1 parent bf370c8 commit dc12081
Show file tree
Hide file tree
Showing 27 changed files with 200 additions and 218 deletions.
10 changes: 0 additions & 10 deletions docs/chrome-extension/quick-access-to-opensauced-links.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/community/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ keywords:
1. **How do I find good first issues?**
We believe that [good first issues don't exist](https://opensauced.pizza/blog/good-first-issues-dont-exist), and the best way to find an issue to work on is to create the issue yourself.

However, sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the search engine of the project you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) by our Triage Team member, Christine Belzie, to learn more.
However, sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the search engine of the project you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) to learn more.

**Additional resources**:

- ["Who's looking for open source contributors?"](https://dev.to/opensauced/whos-looking-for-open-source-contributors-week-46-247i)
- [Intro to Open Source Course](https://intro.opensauced.pizza/)

2. **My contribution does not show up on my OpenSauced profile. How do I fix it?**
Create an [insight page](https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=discovering-open-source-with-opensauced) or adding your merged pull request to [the highlights page](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=develop-your-open-source-resume).
Create an [insight page](https://app.opensauced.pizza/hub/insights) or add your merged pull request to [a highlight](https://app.opensauced.pizza/feed).

3. **I want to provide feedback on OpenSauced.**
We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions).
9 changes: 5 additions & 4 deletions docs/community/welcome-to-the-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,14 @@ The OpenSauced community is a group of open-source enthusiasts who are passionat

You can get involved in the OpenSauced community in a few ways:

- Share your Contributions! We love to see what you're working on. Highlight your contributions on [OpenSauced](https://insights.opensauced.pizza/feed).
- Share your Contributions! We love to see what you're working on. Highlight your contributions on [OpenSauced](https://app.opensauced.pizza/feed).
- Open an issue or ask to be assigned to an existing issue on any of our [OpenSauced repositories](https://github.com/open-sauced).
- Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced).
- Provide feedback on our [GitHub Discussions](https://github.com/orgs/open-sauced/discussions).

## Resources on Getting Started with Open Source
Getting started with open source can be quite daunting for beginners, so we've put together some resources to help you get started.
Getting started with open source can be challenging, so we've put together some resources to help you get started.

- 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors.
- 📖 Take our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) to help you get started with open-source.
- 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open source contributors.
- 📖 Take our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) to help you get started with open source.
- 📅 Join our [#100DaysOfOSS Challenge](https://docs.opensauced.pizza/community/100-days-of-oss/) to help you grow your skills and gain real-world experience in open source.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ Pretty often when opening a pull request it is very likely to run into merge con

To better illustrate the commands listed here at will use commits and screenshots from [open-sauced#1078](https://github.com/open-sauced/open-sauced/pull/1078).

In literally every case it is advised _**not**_ to use the `Resolve conflicts` button as follows:

![don't resolve conflicts like this](../../static/img/contributing-resolve-merge-conflicts-dont-do.png)

The above will at best achieve a ready-to-merge pull request with visible inconsistencies.


## Repository setup

Expand Down Expand Up @@ -74,7 +68,7 @@ git merge origin/main --no-ff -v

You will see something similar to:

![proper merge but results in conflicts](../../static/img/contributing-resolve-merge-conflicts-merge-conflicts.png)
![proper merge but results in conflicts](../../../static/img/contributing-resolve-merge-conflicts-merge-conflicts.png)

## Review changes

Expand All @@ -86,7 +80,7 @@ git diff package.json

It will look like this:

![review merge conflicts](../../static/img/contributing-resolve-merge-conflicts-review-conflicts.png)
![review merge conflicts](../../../static/img/contributing-resolve-merge-conflicts-review-conflicts.png)

## Resolve conflicts

Expand Down Expand Up @@ -119,7 +113,7 @@ git commit

That should look like this:

![commit merge message](../../static/img/contributing-resolve-merge-conflicts-commit-message.png)
![commit merge message](../../../static/img/contributing-resolve-merge-conflicts-commit-message.png)

## Push updated pull request

Expand All @@ -132,19 +126,19 @@ git push

It should look something like this:

![push updated pr](../../static/img/contributing-resolve-merge-conflicts-merge-success.png)
![push updated pr](../../../static/img/contributing-resolve-merge-conflicts-merge-success.png)

## Review your pull request

The result of the above commands can be viewed at [283ff8cd788c550309ff0d1d5a9a5a97ec0731b2](https://github.com/open-sauced/open-sauced/pull/1078/commits/283ff8cd788c550309ff0d1d5a9a5a97ec0731b2)

GitHub will conveniently display only your merge conflict changes:

![view merge commit](../../static/img/contributing-resolve-merge-conflicts-view-merge-commit.png)
![view merge commit](../../../static/img/contributing-resolve-merge-conflicts-view-merge-commit.png)

And it's ready to merge:

![ready to merge](../../static/img/contributing-resolve-merge-conflicts-ready-to-merge.png)
![ready to merge](../../../static/img/contributing-resolve-merge-conflicts-ready-to-merge.png)

## Dependency updates

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/community/lists.md → docs/features/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: 'Lists'
keywords:
- lists
---
The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within your open-source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions.
The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions.

Monitor individual commit histories, track who is actively engaged, identify churned or new contributors, and even compare the performance of contributors against each other. This encompasses a wide range of metrics such as code commits, created and reviewed Pull Requests (PRs), as well as issue creation and commenting.

Expand All @@ -17,6 +17,6 @@ After logging in, navigate to your [Lists page](https://app.opensauced.pizza/hub
There are two ways to add a list:
1. Explore Contributors: Use our explore tool to find contributors and create your list.
2. Import your GitHub following:
Connect to your GitHub to create a list with all the Contributors you follow
Connect to your GitHub to create a list with all the Contributors you follow.

Once your list is created, you'll be able to see an overview of all the contributors in your list, a graph of their activity, and a detailed breakdown of the contributors.
10 changes: 9 additions & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,12 @@ sidebar_label: Introduction to OpenSauced 🍕

[Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s)

OpenSauced provides guidance for new contributors to find their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub-powered dashboard.
OpenSauced is a platform dedicated to empowering maintainers and teams and redefining the meaning of open source contributions. We believe that every contribution, big or small, is valuable and deserves to be recognized. Our platform provides a way to track contributions through a GitHub-powered dashboard, allowing users to showcase their contributions and gain insights into their open source projects.

Our mission is to:

- **Empower maintainers and teams**: Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into you open source projects.
- **Support Contributors**: Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey.
- [**Highlight Success**](../docs/features/highlights.md): Showcase your contributions with our Shareable Highlights, inspiring others to embark on their open-source journey.
- [**Unlock Insights**](../docs/features/insights.md): Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights.

100 changes: 0 additions & 100 deletions docs/maintainers/setting-up-a-new-repository.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ keywords:

Generate an explanation for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.

![generate code refactor](../../static/gif/pr-code-explain.gif)
![generate code refactor](../../../static/gif/pr-code-explain.gif)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This will help you to create a PR based on the configuration you have in the ext

_Note: This feature is not available on private repositories._

![generate pr description](../../static/gif/pr-description.gif)
![generate pr description](../../../static/gif/pr-description.gif)

You can use this settings to set the strictness and the tone of the generated AI, here is an explanation of those settings:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ keywords:

Refactor a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.

![generate code refactor](../../static/gif/pr-code-refactor.gif)
![generate code refactor](../../../static/gif/pr-code-refactor.gif)

Generate tests for a block of code by using the blue plus button that is displayed when hovering over a line. To select a block of code, hover over the starting line, click and drag the blue plus button until the desired line.

![generate code refactor](../../static/gif/pr-code-test.gif)
![generate code refactor](../../../static/gif/pr-code-test.gif)
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
id: viewing-insights-and-invitations
title: 'Viewing Insights and Invitations'
sidebar_label: Insights and Invitations'
sidebar_label: Insights and Invitations
keywords:
- github
- insights and invitations
---
View stats about open issues, PRs made, average PRs velocity, and contributed repos that are in the OpenSauced database. This page can be found by clicking the profile picture at the top left of the extension.

![GitHub Profile Insights](../../static/img/extension-popup.png)
![GitHub Profile Insights](../../../static/img/extension-popup.png)

### Invite GitHub users to join OpenSauced with a single click

Invite other users to create an OpenSauced account to keep track of open source contributions when visiting their GitHub profile.

![Invite GitHub Users](../../static/img/extension-invite.png)
![Invite GitHub Users](../../../static/img/extension-invite.png)

### View GitHub users' OpenSauced profiles and connect with them

View a user’s OpenSauced profile when on their GitHub profile page.

![View OpenSauced Profiles](../../static/img/extension-view.png)
![View OpenSauced Profiles](../../../static/img/extension-view.png)
File renamed without changes.
76 changes: 76 additions & 0 deletions docs/tools/pizza-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
id: pizza-cli
title: Introduction to the Pizza CLI
sidebar_label: Pizza CLI
keywords:
- introduction to the pizza CLI
---

## The OpenSauced Pizza CLI
The OpenSauced Pizza CLI is a command-line utility designed specifically for OpenSauced. It provides a comprehensive set of functionalities that make it easier for users to gain insights, metrics, and manage various tasks related to open source projects through OpenSauced.

Beyond just code commits, the pizza CLI reports on different ways individuals contribute to the open-source ecosystem, be it through community engagement, issue reporting, blog post writings, or pull request creations.

## Key Features

- Bake: Seamlessly source git commits into OpenSauced with the metaphorical 'oven' of technology.
- Insights: Dive deep into data about git contributors, repositories, users, and pull requests.
- Repo-query: Get your questions answered about any GitHub repository.
- Show: Visualize the metrics of a repository, providing a holistic view of its health and activity.
- Login: Securely log into the application via GitHub, ensuring a streamlined and safe experience.

## Installation and Instructions

📦 Download & Install
The pizza CLI provides multiple installation methods to cater to the varied preferences of its users:

- Homebrew: For macOS users who prefer the Homebrew package manager:

```bash
brew install open-sauced/tap/pizza
```

NPM: For those who are fond of the Node Package Manager:

```bash
npm i -g pizza
```

Direct Script Install: A quick way to get started by directly fetching the installation script from GitHub:

```bash
curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh
```
⚠️ Warning: Piping scripts directly from the web to your shell can be risky. Always ensure you trust the source. For a safer approach, download, inspect, and then execute:

```bash
curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh > install.sh
vim install.sh
./install.sh
```
Manual Build and Install: For those who like a hands-on approach:

```bash
make install
```
Ensure /usr/local/bin/ is in your path with:

```bash
export PATH="$PATH:/usr/local/bin"
```
Alternatively, after building with make build, move the binary to your desired location:

```bash
mv build/pizza <your-preferred-path>
```
### 🖥️ Local Development Setup
To contribute to or modify the pizza CLI, you need a specific set of tools:

- Go Toolchain: The foundational tool for building and managing Go applications.
- Docker: Required for linting and other auxiliary tooling.
- Make: A build automation tool.
Development Commands:

- Linting: Ensure code quality with make lint.
- Testing: Verify functionality with make test.
- Building: Create the executable with make build.
Loading

0 comments on commit dc12081

Please sign in to comment.