Answers to frequently asked questions.
+ +Open PR
+Some examples of when you may want to open a PR:
+Generally speaking, if you know how to open a PR in order to fix the issue, doing that is best. However, we recognise that it requires knowledge of GitHub and code to some degree, which is a form of gatekeeping. We're currently working on ways to improve/remove this barrier to entry. We also are always willing to help if you'd like to learn. Reach out via our Slack community
+Open Issue
+Some examples of when you may want to open an issue:
+Related: Contributing Guidelines
diff --git a/11ty/documentation/index.md b/11ty/documentation/index.md index 8df093fc..af992485 100644 --- a/11ty/documentation/index.md +++ b/11ty/documentation/index.md @@ -4,6 +4,7 @@ title: Docs As always, documentation is a work in progress. However, this is what we have so far: -- [Examples](/documentation/examples/): Grab-and-go definition examples -- [Front Matter](/documentation/front-matter/): Configuration possibilities through front matter - [Development & Build](/documentation/development/): Notes for developing the site +- [Front Matter](/documentation/front-matter/): Configuration possibilities through front matter +- [Examples](/documentation/examples/): Grab-and-go definition examples +- [FAQs](/documentation/frequently-asked-questions): Answers to frequently asked questions diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1845cea..69ac085a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ Please remember that the contributing team is always here to [help](#get-help). Below we describe two ways for you to get started: through [issues](#version-1-issues) or [pull requests](#version-2-pull-requests). --- -**Note:** We also have [documentation](https://www.selfdefined.app/documentation/) that covers development and build processes, provides examples, and describes front matter configurations. +**Note:** We also have [documentation](https://www.selfdefined.app/documentation/) that covers development and build processes, provides examples, frequently asked questions, and describes front matter configurations. --- @@ -81,10 +81,13 @@ For this tutorial we will take the word «Obsessive Compulsive Disorder», as it We have created some examples that you can use as the baseline for your work. Take a look at the [File Examples](https://www.selfdefined.app/documentation/examples/) section of our documentation. +**Related:** [When should I open an issue versus a pull request (PR)?](https://www.selfdefined.app/documentation/frequently-asked-questions/#when-should-i-open-an-issue-versus-a-pull-request) + ## Get Help If you've already tried reading through our [documentation](https://www.selfdefined.app/documentation/) and are stuck, we're here to help and ask your questions: +- Join our [Slack community](https://join.slack.com/t/selfdefined/shared_invite/zt-fczgm8b6-8ZZgHvLutNDXo~NjwaL7Iw). - Reach out to [@SelfDefinedApp](https://www.twitter.com/selfdefinedapp) on Twitter. - File an [issue](https://github.com/tatianamac/selfdefined/issues/new) if you think our docs are missing some information that might be helpful. - Contact