-
-
Notifications
You must be signed in to change notification settings - Fork 170
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
Add Frequently Asked Questions (FAQ) to contributing guidelines/documentation #246
Comments
Did you want to start an FAQ section under the "Development & Build" or "Documentation? |
This FAQ content ^ helped me decide on whether or not to create PR 285 - gracias! |
@donnavitan Sorry for missing this comment! I think I'd honestly like a FAQ would serve both areas! In general I'd like even an FAQ PAGE that has frequently asked questions (selfishly, a lot of it is questions that I get asked via DMs, emails, etc could be addressed here). I'm happy to provide more context here. Is this something you'd be willing to take on? @mannybecerra Don't know if you'd be willing to help/lead as well since you found this helpful? |
I'd be happy to assist here. @donnavitan I can follow your lead here with @tatianamac 's direction or in whatever other way y'all fancy to approach this. On standby... |
@mannybecerra As I'm not positive if @donnavitan is around here, would you be open to opening a PR to address this? From there we can see if @donnavitan is available to contribute and provide more context/edit as they're able? I think this way we'll keep things moving while respecting both Donna's participation if so chosen. |
Absolutely, agreed @tatianamac . I'll get on it and reach out with any Qs along the way. ¿Bueno? |
… Documentation page and cross-linked accordingly. Corresponds to issue selfdefined#246
… Contributing Guidelines docs. Corresponds to issue selfdefined#246
@mannybecerra @tatianamac This is great! Thank you for moving forward. I'm still figuring this out and will contribute! @tatianamac What's the best to way to collect the FAQ you've received? Without having you do much more work! Could we open a shared Google doc where you can drop the Qs and As, where we can help edit? |
@donnavitan hey now—you betcha, team effort! I'd love your co-lead on curating FAQs for the new page. I think a goal we should strive for, you nailed in your comment: keeping the labor/work on Tatiana's part low-friction. Google doc seems like a good place to centralize this type of dynamic content, especially when we consider extending future work with translators. I'll follow your lead |
…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
* 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 <[email protected]> * Update 11ty/documentation/frequently-asked-questions.md Copy feedback from Tatiana Co-authored-by: Tatiana Mac <[email protected]> * 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 <[email protected]> Co-authored-by: Tatiana Mac <[email protected]>
When should I open an issue versus a PR?
Open PR
Open Issue
The text was updated successfully, but these errors were encountered: