Skip to content

Commit

Permalink
docs: Provide Docs Feedback & Fix Markdown and Metadata for Consisten…
Browse files Browse the repository at this point in the history
…cy (#213)

* Fix spacing and indentation for consistency

* Fix punctuations and capitalizations in metadata for consistency

* Fix typo in introduction.md

* Fix capitalization and wordings in highlights.md

* Adjust content in dev-card.md

* Add link to Lists feature in connections.md
* Fix capitalization in lists.md

* Adjust wordings in connections.md

* Fix capitalization in sidebars.js

* Adjust titles in welcome-to-the-community.md

* Change Twitter to X in welcome-to-the-community.md

* Adjust wordings in welcome-to-the-community.md

* Change 100DaysOfOSS external to internal link in welcome-to-the-community.md

* Fix and adjust wordings in 100-days-of-oss.md

* Fix titles capitalization in 100-days-of-oss.md

* Change OpenSauced/Insights to OpenSauced/App repository in 100-days-of-oss.md
* Minor wording fix

* Fix am/pm time following writing best practice and for consistency

* Add an h2 of Contributions in faqs.md

* Fix spacing and indentation in faqs.md

* Fix punctuation and capitalization in faqs.md
* Adjust wordings

* Fix link and wordings in additional resources in faqs.md

* Fix titles capitalization in hot-opensauced.md

* Bold keywords in the Key Features section in pizza-cli.md

* Add an h3 in Installation and Instructions section in pizza.cli.md

* Fix list and bold keywords in Installation and Instructions section on pizza-cli.md

* Fix list format and bold keywords in Local Development Setup section in pizza-cli.md

* Add link to Go Toolchain and Docker

* Minor wordings adjustments in pizza-cli.md

* Minor wordings adjustment in introduction to the Chrome extension

* Fix capitalization in the list in pr-descriptions.md

* Adjust wordings in the first paragraph of pr-description.md

* Add back ticks to the example in pr-description.md

* Adjust wordings and content in highlights.md of Chrome extension

* Improve the wordings in highlights.md for clarification

* Omit the word issue
creating highlights with extension only works on PR at the moment

* Add h2 for refactoring and testing a block of code

* Fix title capitalization in viewing-insights-and-invitations.md

* Fix title capitalizations in introduction-to-contributing.md

* Fix the structure of Setup section in introduction-to-contributing.md

* Fix wordings and punctuations in introduction-to-contributing.md

* Add links to introduction-to-contributing.md

* Minor fix

* Remove pr-velocity.md to follow the latest update

* Fix title capitalizations in the code-of-conduct.md

* Minor wordings fix and punctuations in code-of-conduct.md

* Add list of examples in Scope section of code-of-conduct.md for better readable

* Fix punctuations in Attribution section of code-of-conduct.md

* Adjust and fix title capitalizations in triage-guide.md

* Adjust wordings and structure in triage-guide.md

* Fix capitalization and spacing in set-up-authetication.md

* Fix punctuations and minor wordings adjustment in maintainers-guide.md

* Fix title capitalizations in introduction-to-storybook.md

* Change list from HTML to Markdown in UI Categories section of introduction-to-storybook.md

* Adjust wordings in first paragraph of Introduction to Storybook section for clarity

* Add language names to highlight code blocks
* Fix spacing

* Fix title capitalizations in setup-repo-with-git.md

* Adjust wordings in setup-repo-with-git.md

* Change code blocks highlight language from bash to shell for consistency

* Fix title capitalizations in resolve-merge-conflicts.md

* Minor wordings adjustment in resolve-merge-conflicts.md

* Adjust a section title in resolve-merge-conflicts.md

* Add punctuations

* Fix title capitalizations, punctuations and typos in check-engines.md

* Fix capitalization and add punctuation in conventional-commit.md

* Fix capitalizations, punctuations and typos in semantic-release.md

* Update 100-days-of-oss.md

* Update welcome-to-the-community.md

* Update docs/contributing/introduction-to-contributing.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/contributing/introduction-to-contributing.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/contributing/introduction-to-contributing.md

Co-authored-by: Ayu Adiati <[email protected]>

* Add double quotes to title, sidebar_label and keywords in metadata

* Fix metadata and capitalization in introduction.md

* Minor wordings fix in 100-days-of-oss.md

* Change list to h3 in faqs.md

* Adjust wordings in faqs.md

* Fix wordings for PR rules in introduction-to-contributing.md

* Reorg subsections in the PR section of introduction-to-contributing.md

* Add Commits title in introduction-to-contributing.md

* Add Adding Issue and PR Labels title in triage-guide.md
* Change title from Issue Triage Process to Triage Process

* Move Labeling good first issue section into Triage Process section

* Minor wordings fix in triage-guide.md

* Fix link in introduction-to-contributing.md

* Change word TC to Triage Team

* Minor wording and capitalization fixes in opensauced-intro.md

* Change open-sauced.git to app.git in setup-repo-with-git.md

* Move position of a subsection for better flow in setup-repo-with-git.md

* Remove a broken link and adjust wordings in Configuration section of semantic-release.md

* Fix punctuations and minor wordings adjusment

* Omit coupon in connections.md

* Adjust wordings in the settings explanation in pr-description.md

* Add link to ghcr in semantic-release.md

* Minor wordings adjustment for PR Velocity

* Explain OP in triage-guide.md

* Remove empty file

* Clarify who can see permissions

* Clarify breaking changes

* Remove welcome-to-the-community.md file from the root

* Fix title capitalizations in job seekers guide

* Revert settings explanation in pr-description.md to previous version

* Revert intro paragraphs in highlights.md to previous version

---------

Co-authored-by: BekahHW <[email protected]>
Co-authored-by: Rebekah Hawrot Weigel <[email protected]>
  • Loading branch information
3 people authored Dec 7, 2023
1 parent d20567b commit 7264c3e
Show file tree
Hide file tree
Showing 38 changed files with 647 additions and 580 deletions.
132 changes: 68 additions & 64 deletions docs/community/100-days-of-oss.md

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions docs/community/hacktoberfest.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: hacktoberfest
title: 'Join us for Hacktoberfest! 🎃'
sidebar_label: 'Join us for Hacktoberfest! 🎃'
id: hacktoberfest
title: "Join us for Hacktoberfest! 🎃"
sidebar_label: "Join us for Hacktoberfest! 🎃"
keywords:
- hacktoberfest
- "hacktoberfest"
---

At OpenSauced, we love open source just as much as pizza! That's why we are participating in Hacktoberfest! 🎃

## What is Hacktoberfest?
Expand All @@ -26,7 +27,7 @@ This event is a great way to jumpstart your journey in open source, to meet othe

No problem! 😄 Here is a list of resources we recommend for first-time contributors:

- Take our [Intro to Open Source](https://intro.opensauced.pizza/#/) course to learn the history of open source, the tools to succeed in the community, and how to showcase your contributions.
- Take our [Intro to Open Source](https://intro.opensauced.pizza/#/) course to learn the history of open source, the tools to succeed in the community, and how to showcase your contributions.
- Check out GitHub's [introductory course](https://github.com/skills/introduction-to-github) to learn how to use the platform when making open source contributions.
- Read our [The Power of Git](https://dev.to/opensauced/the-power-of-git-a-guide-to-collaborative-version-control-dl6) blog post to learn how to harness the power of Git, your trusty weapon in Hacktoberfest.

Expand All @@ -36,7 +37,7 @@ During Hacktoberfest, expect to feel excited and a bit competitive on your quest

- Think first, work later: It's best to share your ideas and/or request to work on an issue before submitting a pull request. It'll make it easier for maintainers to assess whether your suggestion fits in with their project. It will also help you develop your communication skills.
- Be patient: Maintainers are people with lives outside of open source, so avoid constantly messaging them about when your pull request be reviewed and merged.
- Try new things: While revising typos is helpful, it's best to diversify contributions. This would help expand your skills, which is very useful if you plan on using your Hacktoberfest contributions as samples for your portfolio.
- Try new things: While revising typos is helpful, it's best to diversify contributions. This would help expand your skills, which is very useful if you plan on using your Hacktoberfest contributions as samples for your portfolio.

## I'm ready for Hacktoberfest

Expand Down
35 changes: 17 additions & 18 deletions docs/community/welcome-to-the-community.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,45 @@
---
id: welcome-to-the-community
title: Welcome to the Community
sidebar_label: Welcome to the Community
title: "Welcome to the OpenSauced Community"
sidebar_label: "Welcome to the Community"
keywords:
- welcome to the community
- "welcome to the community"
---

## The OpenSauced Community
Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.

Welcome to the OpenSauced community! At OpenSauced, we're striving to bring collaboration and inspiration to every open source contributor and to help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.
## Community Guidelines

### Community Guidelines

At OpenSauced, we strive to create a welcoming and inclusive community for everyone. We have a few guidelines to help us achieve this goal:
We pledge to create a welcoming and inclusive community for everyone at OpenSauced. We have a few guidelines to help us achieve this goal:

- Be respectful and kind to others in the community.
- Be patient with others and help them learn.
- Be open to feedback and constructive criticism.
- Adhere to the [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md).
- Adhere to the [Code of Conduct](../contributing/code-of-conduct.md).

## What's the OpenSauced Community up to?
## Keeping Up with OpenSauced

The OpenSauced community is a group of open-source enthusiasts who are passionate about making open-source more accessible to everyone. Here are some ways you can keep up with what we're doing:
The OpenSauced community is a group of open source enthusiasts who are passionate about making open source more accessible to everyone. Here are some ways you can keep up with what we're doing:

- 🐦 Follow us on Twitter [@SaucedOpen](https://twitter.com/saucedopen) for announcements and our frequent Twitter Spaces.
- Join our [Discord](https://discord.gg/opensauced), and hang out with us in our weekly office hours.
- Follow us on X [@SaucedOpen](https://twitter.com/saucedopen) for announcements and our frequent X Spaces.
- Join our [Discord](https://discord.gg/opensauced) and hang out with us during our weekly office hours.
- Subscribe to our [YouTube channel](https://www.youtube.com/@OpenSauced) for the latest updates and video content for OpenSauced.
- 📰 Subscribe to our [newsletter](https://news.opensauced.pizza/#/portal/signup) for all things OpenSauced and open source.
- 🗓️ Check out the [calendar](https://calendar.google.com/calendar/u/0?cid=Y19kYWRhODM2MjlhZDg4ZWM2M2IxZGFmMTE5MDIyMDg0MjU2ZmQ4NmNjNWNhYmMxMjk5MDhjMGUxOTY3NjY4ZTg0QGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20) for our next weekly community chat.

## How can I get involved?
## How to Get Involved

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://app.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 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.
- 📅 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.
- 📝 Check out our [blog on Dev.to](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 start with open source.
- 📅 Join our [#100DaysOfOSS Challenge](100-days-of-oss.md) to help you grow your skills and gain real-world experience in open source.
78 changes: 30 additions & 48 deletions docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,62 @@
---
id: code-of-conduct
title: Code of Conduct
sidebar_label: Code of Conduct
title: "Code of Conduct"
sidebar_label: "Code of Conduct"
keywords:
- code of conduct
- "code of conduct"
---

## Our pledge
## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our standards
## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
- Using welcoming and inclusive language.
- Being respectful of differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' confidential information, such as a physical or electronic address, without explicit permission.
- Other conduct that could reasonably be considered inappropriate in a professional setting.

## Our responsibilities
## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include:

- Using an official project e-mail address.
- Posting via an official social media account.
- Acting as an appointed representative at an online or offline event.

Representation of a project may be further defined and clarified by project maintainers.

## 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]. 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.
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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://contributor-covenant.org/version/1/4][version]
This Code of Conduct is adapted from the [Contributor Covenant][homepage] version 1.4,
available at [https://contributor-covenant.org/version/1/4][version].

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/
Loading

0 comments on commit 7264c3e

Please sign in to comment.