Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix formatting and punctuation in documentation files #421

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/community/100-days-of-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Your OpenSauced Profile, includes your DevCard, which is a great way to track yo

#### How to check your OSCR

Go to your OpenSauced Profile. For example, https://app.opensauced.pizza/u/bekahhw. You can also check out [this contributor insight page](https://app.opensauced.pizza/workspaces/cff3f17b-f052-4686-85af-72971009136b/contributor-insights/545c756a-39e0-4361-b516-9610cb413959/overview) to see the members of our 2024 cohort.
Go to your OpenSauced Profile. For [example](https://app.opensauced.pizza/u/bekahhw). You can also check out [this contributor insight page](https://app.opensauced.pizza/workspaces/cff3f17b-f052-4686-85af-72971009136b/contributor-insights/545c756a-39e0-4361-b516-9610cb413959/overview) to see the members of our 2024 cohort.

Remember, there's value in knowing the story behind the numbers. When you share your DevCard, tell the story behind your number.
Remember, there's value in knowing the story behind the numbers. When you share your DevCard, tell the story behind your number.

[![DevCard](../../static/img/DevCard.png)](https://app.opensauced.pizza/u/bekahhw/card)

Expand All @@ -94,7 +94,7 @@ To make the most of your #100DaysOfOSS journey, here are some additional resourc

If you're ready to start your #100DaysOfOSS journey, here are some tips to help you get started:

- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you.
- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you.
- **Take our Intro To Open Source course:** If you're new to open source, we recommend taking our [Intro to Open Source course](https://opensauced.pizza/learn/#/) to learn more about open source and how to get started.
- **Record your journey:** You will learn a lot as you navigate this challenge, so we highly recommend using our [#100DaysOfOSS journal template](https://github.com/open-sauced/100-days-of-oss-template) on GitHub or [Notion](https://www.notion.so/a0m0rajab/100-Days-Of-Open-Source-2615e66772e14152897002e348c5f1bc?pvs=13) to help you reflect. Remember, this is _your_ journey, so feel free to customize them however you like.
- **Check our Contributors Guide:** If you're new to contributing to open source, we recommend checking out our [Contributors Guide to OpenSauced](https://opensauced.pizza/docs/contributors/contributors-guide-to-open-sauced/) to learn more about the process and best practices.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Representation of a project may be further defined and clarified by project main

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Please be sure to add `page: true` to your author entry to generate your author
:::

**Example:**

```yaml
BekahHW:
name: Bekah Hawrot Weigel
Expand Down Expand Up @@ -50,21 +51,20 @@ All authors should include their name and an image URL. The title, URL, and emai

If you do want to include a URL, you can include your OpenSauced profile, X, LinkedIn, personal website, etc.


## Adding Blog Posts

To publish in the blog, create a Markdown file within the blog directory. Note that we have subdirectories for each year, so writers should add their posts to the folder that corresponds with the year.

**Example Path:** `/blog/2024/06-03-welcome-opensauced.md`


:::info

You'll notice that many of the files include the year. These were created before we started using the year subdirectories. Either way works, but we're moving towards the year subdirectories for organization and omitting the year in the file name.

:::

**Markdown Example:**

```markdown
docs/blog/2024/06-03-welcome-opensauced.md
---
Expand Down Expand Up @@ -99,16 +99,18 @@ The front matter is the metadata at the top of the Markdown file. It includes th
authors:[BekahHW, nickytonline]
---
```

- **tags:** Tags are used to categorize the blog post. They should be lowercase and separated by commas and highlight the main topics of the blog post.
- **hide_table_of_contents:** This is a boolean value that determines whether the table of contents will be displayed. If you want to hide the table of contents, set it to `true`.

### Blog List

The blog's index page (a custom path for OpenSauced at `/community-resources`) is the blog list page, where all blog posts are collectively displayed.

Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown.
Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown.

**Markdown Example:**

```markdown
website/blog/my-post.md
---
Expand All @@ -124,8 +126,8 @@ But anything from here on down will not be.

### Image Usage

We are not going to use images in the front matter. The rest of the post should be in markdown format.
We are not going to use images in the front matter. The rest of the post should be in markdown format.

If you want to include images within your post, please use only images that directly relate to the content of the post. If you need to add an image to the repository (rather than linking from somewhere else), you can add it to the `/static` directory in the `gif` or `img` subdirectory.

By following these guidelines, you will ensure consistency and ease of maintenance across our blog posts. Happy writing!
By following these guidelines, you will ensure consistency and ease of maintenance across our blog posts. Happy writing!
1 change: 1 addition & 0 deletions docs/contributing/technical/resolve-merge-conflicts.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ cd project-name
```bash
git remote add upstream https://github.com/upstream-username/upstream-repository.git
```

3. Pull the latest changes from the `upstream`.

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/contributors/contributors-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Your profile is a great resource for showcasing your contributions and sharing y

On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions), and two other tabs:

- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to.
- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to.

Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. There is also an option to view the user's latest issue comments. The contributions tab is helpful if you want to showcase a steady and consistent open source contribution experience.

Expand Down
4 changes: 2 additions & 2 deletions docs/features/contributor-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ By default, your Contributor Insight Page is public. If your Contributor Insight

On your Contributor Insight Page, you'll see that each contributor is assigned an [OSCR](../welcome/glossary.md#oscr). The OSCR is a metric to evaluate the engagement and impact of contributors across the entire open source ecosystem. This score aims to give insight into a contributor's involvement and the value they bring to open source communities as a whole.

The OSCR takes into account various factors related to all of the contributor's activity and the quality of their contributions in open source.
The OSCR takes into account various factors related to all of the contributor's activity and the quality of their contributions in open source.

:::info
OSCRs are calculated on a rolling 90-day basis across all of a contributor's activity and are out of 300 total points. This means the score reflects recent activity and engagement, providing a current snapshot of a contributor's open source involvement rather than a lifetime aggregate.
Expand All @@ -61,4 +61,4 @@ Here are some of the ways, the OSCR can be used:
- Tracking contributor growth over time
- Encouraging sustained participation in open source

OSCRs are designed to be a helpful tool in understanding current open source dynamics, but should be considered alongside other factors when evaluating contributors or projects.
OSCRs are designed to be a helpful tool in understanding current open source dynamics, but should be considered alongside other factors when evaluating contributors or projects.
4 changes: 2 additions & 2 deletions docs/features/repo-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ keywords:
- "Open Source Project Repository Insights"
---

The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.
The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.

![insight-pages-demo](../../static/gif/insight-page-demo.gif)

Expand Down Expand Up @@ -60,4 +60,4 @@ This method gives view-only access to your Repository Insights Page.
3. On the top right, click the "Share" button to copy the Repository Insight Page URL to the clipboard.
4. Share the URL with your team members.

By default, your Repository Insights are public. If you want to make your Repository Insights private, you can change it in the settings.
By default, your Repository Insights are public. If you want to make your Repository Insights private, you can change it in the settings.
Loading
Loading