forked from selfdefined/web-app
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…plate since we're utilizing dl, dt & dd markup tags for our FAQ content. Changes include corresponding CSS rules for dl and dt tags and minor punctuation update in the contributing guidelines. Addresses issue selfdefined#246
- Loading branch information
1 parent
5552abd
commit e793749
Showing
4 changed files
with
42 additions
and
33 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: FAQs | ||
parent: | ||
title: Documentation | ||
href: '/documentation' | ||
--- | ||
|
||
<p>Answers to frequently asked questions.</p> | ||
|
||
<dl> | ||
<dt id="when-should-i-open-an-issue-versus-a-pull-request">When should I open an issue versus a pull request (<abbr title="Pull Request">PR</abbr>)?</dt> | ||
<dd class="u-margin-top-double"> | ||
<p><strong>Open <abbr title="Pull Request">PR</abbr></strong></p> | ||
<p>Some examples of when you may want to open a <abbr title="Pull Request">PR</abbr>:</p> | ||
<ul> | ||
<li>Correct misspellings</li> | ||
<li>Fix broken links</li> | ||
<li>Add definitions/nuance/translations to words that exist on the site already but are undefined/partially defined/could use more nuance</li> | ||
<li>Resolve issues that already exist</li> | ||
</ul> | ||
<p>Generally speaking, if you know how to open a <abbr title="Pull Request">PR</abbr> 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 <a href="//join.slack.com/t/selfdefined/shared_invite/zt-fczgm8b6-8ZZgHvLutNDXo~NjwaL7Iw">Slack community</a></p> | ||
</dd> | ||
<dd class="u-margin-top-double"> | ||
<p><strong>Open Issue</strong></p> | ||
<p>Some examples of when you may want to open an issue:</p> | ||
<ul> | ||
<li>Are not sure how to open a <abbr title="Pull Request">PR</abbr> but have a suggestion</li> | ||
<li>Express concern or ask a question around a term that you don't have clear prescriptive feedback around</li> | ||
<li>Add a new term that is not yet listed (with or without definition)</li> | ||
<li>Add or enhance a feature that you're unsure is desired</li> | ||
</ul> | ||
</dd> | ||
</dl> | ||
|
||
<p><strong>Related:</strong> <a href="//github.com/selfdefined/web-app/blob/prod/CONTRIBUTING.md">Contributing Guidelines</a></p> |
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 |
---|---|---|
|
@@ -81,13 +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-(pr)%13F) | ||
**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) | ||
- 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 <[email protected]>. |
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