-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
27 changed files
with
200 additions
and
218 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 4 additions & 4 deletions
8
...nsion/viewing-insights-and-invitations.md → ...nsion/viewing-insights-and-invitations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Oops, something went wrong.