Skip to content
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

Initial Frequently Asked Questions (FAQs) Page (Issue #246) #288

Merged

Conversation

mannybecerra
Copy link
Contributor

@mannybecerra mannybecerra commented Aug 29, 2020

Hey Team,

This is the initial creation of the requested Frequently Asked Questions (FAQs) page for issue #246.

Summary

  • The FAQ page is a child of the Documentation page and linked to accordingly.
  • The slug/route of the FAQ page is /documentation/frequently-asked-questions (relative to the app's root)
  • This new page is also cross-referenced and linked to from the Contributing Guidelines docs

Notes:

  • This page went through two noticeable iterations: the first PR changes, followed by a refactor of the FAQ page for leveraging dl, dt & dd markup tags for the FAQ content. Context can be found in our Slack channel here and over here
  • @tatianamac in the thread under Add Frequently Asked Questions (FAQ) to contributing guidelines/documentation #246 , I've inferred that you may have more content around FAQs that you've collected ala DMs and other channels. If you would like for me to help get any of that other content worked into this new page, even under sub-categories, just lemme know.

If changes are desired before merging this PR, I'm on standby to review and implement any requests.

Gracias 🙌🏼

UI Screenshots

Lighthouse results (on local environment)

Screen shot of Lighthouse profile and performance results

New FAQs Page

Screen shot of new Frequently Asked Questions (FAQs) page under Documentation

Updated Documentation Page

Screen shot of the existing Documentation page for Self-Defined app updated to link to the new Frequently Asked Questions page

Updated Contributing Guidelines Doc

Screen shot of the existing Contributing Guidelines doc updated to cross-reference the new Frequently Asked Questions page

@tatianamac
Copy link
Collaborator

@mannybecerra Excellent work! I provided some prescriptive edits using the suggestions functionality. Please take a look and let me know if I can clarify anything.

As for other questions, I think it'd be great to collect some questions from folks in the Slack community and I can start to answer them. Would you be willing to lead that?

@tatianamac
Copy link
Collaborator

@mannybecerra I would prefer the latter, personally.

@mannybecerra
Copy link
Contributor Author

@mannybecerra I would prefer the latter, personally.

@tatianamac sweet. I just saw your other comment about the prescriptive edits before I posted my original linting question to you. After seeing it, I was just going to move my question to your other question's thread to keep it all intact but now I just created a whirlwind. I'll update the FAQs content to leverage dl markup and take a look at your suggestions as well.

Regarding I think it'd be great to collect some questions from folks in the Slack community and I can start to answer them. Would you be willing to lead that?, you bet. Just so I have some direction on what may work best for you on this front, do you have an approach that may work best for you in me leading this or do you want me to just run with it and we'll fine tune things along the way?

@tatianamac
Copy link
Collaborator

I trust you to take whatever approach makes the most sense with this. Mostly, I think there are valuable insights from the community built there. I think it could empower folks who have found our documentation confusing or unclear to get started.

Re: edits: Sounds perfect! Thank you again!

@mannybecerra
Copy link
Contributor Author

I trust you to take whatever approach makes the most sense with this. Mostly, I think there are valuable insights from the community built there. I think it could empower folks who have found our documentation confusing or unclear to get started.

Re: edits: Sounds perfect! Thank you again!

Great @tatianamac , thanks.

I am hitting a snag with with the FAQ page and converting the content to use dl markup; 11ty's preprocessor doesn't seem to recognize the extended syntax for dl as outlined here, https://www.markdownguide.org/extended-syntax/#definition-lists. I'll reach out to our Slack community to see if you and others have insight on this

…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
@mannybecerra
Copy link
Contributor Author

@mannybecerra I would prefer the latter, personally.

I agree @tatianamac . Done e793749

@mannybecerra mannybecerra marked this pull request as ready for review August 31, 2020 22:46
Copy link
Collaborator

@tatianamac tatianamac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 LGTM!

@tatianamac
Copy link
Collaborator

@mannybecerra I'll merge in this PR and if you'd like to work further on questions, we can collect those for a new PR.

@tatianamac tatianamac merged commit 019d809 into selfdefined:prod Sep 1, 2020
@mannybecerra
Copy link
Contributor Author

@mannybecerra I'll merge in this PR and if you'd like to work further on questions, we can collect those for a new PR.

Suena bien @tatianamac !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants