Eddiebot: Creating an FAQ.md

[Akshu-on-github]

Since there are some questions brought up often by new contributors - like issue #320 and 'How can I be a part of the organization' - I thought an FAQ page would be a good solution. Can I create one?

[github-actions[bot]]

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community :nerd_face:

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

[eddiejaoude]

There is the tips command, would the faq one be similar? It would be good to have it as an md file so we can also load it on the website - I wonder what other people thing? @BOLT04 @AllanRegush @stemount @alrifay ... etc

[Akshu-on-github]

Now that you mention it, they'd be quite similar, yeah!

[AllanRegush]

I think for issue #320 it should be in the documentation. For 'How can I be a part of the orgainzation' this is in the introductions channel posted by mee6 and this is also on our web page. https://eddiejaoudecommunity.github.io/ Maybe we should consider something like our words command that searches for how do I join? and posts the link.

I think adding to the tips command overall would value.

[BOLT04]

Hi @AkshayaKulasekaran 😃, there are similar issues to this one also related to having a FAQ section somewhere: https://github.com/EddieJaoudeCommunity/support/issues/259 and #197

There is the tips command, would the faq one be similar?

I agree with @eddiejaoude, a ^faq command would be cool to have to list the most popular questions, and then have a link to the section on the repo that has the FAQ. This way the Discord message is not that big, and the user can check more questions with the link.

I agree with @AllanRegush that the issue #320 can be addressed with documentation about the Alex configuration.

Maybe we should consider something like our words command that searches for how do I join? and posts the link.

Awesome idea 👍 👍 !! The challenge here I'd guess it's the different possibilities on how people ask that.

For the "How can I be a part of the organization" question, yes we get that a lot and so we have that question on this FAQ. The FAQ on the support repo currently has generic questions and I think we can have a FAQ on this repo to have specific questions related to EddieBot.

[Akshu-on-github]

@BOLT04, I haven't had a good look at the support repo, my bad 😅

Do we have a link that goes to the support repo anywhere? I might have missed it if there is, but if there isn't, I guess we should add one in

[BOLT04]

@AkshayaKulasekaran i think we have a command for that: ^support. It shows a link to the discussions section, but it's still the support repo 😃

[Akshu-on-github]

Ah, sorry, just saw this now!

Thanks @BOLT04, I got it!

[eddiejaoude]

I haven't had a good look at the support repo, my bad 😅

@AkshayaKulasekaran that is fine, we need to make it easier for people without having to go have a "good" look for it. Any suggestions on where people first look?

[Akshu-on-github]

@eddiejaoude, I think most would look at the first few lines of README.md, then hop onto CONTRIBUTING.md

I'd suggest adding an intro to the readme. We needn't draft up a new one, we could just put this one at the top -

-rephrase it, and add in a link to the Support repo

[stemount]

@EddieJaoudeCommunity/coreteam I think ^support, ^tips and ^faq could be consolidated into one.

<stemount> ^faq join the community
<EddieBot> one-liner nicer FAQ here

<stemount> ^faq opensource
<EddieBot> we have tips and FAQs for open source here: https://github.com/blah/src/OPENSOURCE.md

[BOLT04]

@stemount do you mean those 3 features would be inside the command faq? So the change you are proposing is to create that faq command and it will receive one argument, which can be a string that could match to a frequent asked question, or "support" or a section of the tips feature?

[eddiejaoude]

If those commands are being combined, they could be aliases to each other?

[Vyvy-vi]

we could alias tips to faq 👍