mirror of
				https://github.com/fooflington/selfdefined.git
				synced 2025-10-31 14:18:32 +00:00 
			
		
		
		
	* Initial Frequently Asked Questions (FAQs) page that is a child to the Documentation page and cross-linked accordingly. Corresponds to issue #246 * Cross-referencing and linking to the new FAQs page (b55ec86) from the Contributing Guidelines docs. Corresponds to issue #246 * Doh! Inadvertently removed the `Get Help` sub-heading under c98290e; this commit adds `Get Help` back * linting - updating unordered bullets to dash instead of asterisk * adding copy and link to joining the Self-Defined app Slack community per feedback from Tatiana * Update 11ty/documentation/index.md Feedback from Tatiana Co-authored-by: Tatiana Mac <github@tatianamac.com> * Update 11ty/documentation/frequently-asked-questions.md Copy feedback from Tatiana Co-authored-by: Tatiana Mac <github@tatianamac.com> * tidying up copy for FAQs page per Tatiana feedback, specifically under `Open PR` * additional copy cleanup and updates per Tatiana PR feedback * converting the FAQ markdown page (b55ec86, 5552abd) to a njk html template 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 #246 Co-authored-by: Manny Becerra <mannybecerra@users.noreply.github.com> Co-authored-by: Tatiana Mac <github@tatianamac.com>
This commit is contained in:
		
							
								
								
									
										35
									
								
								11ty/documentation/frequently-asked-questions.njk
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								11ty/documentation/frequently-asked-questions.njk
									
									
									
									
									
										Normal file
									
								
							| @@ -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> | ||||
| @@ -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 | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Manny Becerra
					Manny Becerra