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

Curate technical FAQs that usually come through Slack/Discord #2070

Closed
merelcht opened this issue Nov 28, 2022 · 2 comments
Closed

Curate technical FAQs that usually come through Slack/Discord #2070

merelcht opened this issue Nov 28, 2022 · 2 comments

Comments

@merelcht
Copy link
Member

merelcht commented Nov 28, 2022

Description

Subtask for #1985

  • Curate list of questions that are asked a lot on Slack/Discord and should go on the FAQs page in the docs
  • Write good answers for the questions
@stichbury
Copy link
Contributor

stichbury commented Nov 29, 2022

I'm not too keen creating a knowledgebase as I've articulated in a previous issue*. I don't think we should have FAQs in the docs because they date and it's hard to keep them general enough to be relevant while specific enough to solve any individual problem.

I instead think we should have a better way for people to search the archive of previous Q&A pairs to get information, and move the FAQs that we do have, that are high level, onto the website.

If we know there are specific commonly-asked questions, we should instead deal with what they are and why they are asked regularly. Maybe we need more documentation about a particular issue (or to solve that particular problem in the associated docs). Maybe we need a change in the framework or viz to avoid the issue happening. I don't think that a knowledgebase is the answer, personally.

  • That all said, we DO need to know what people are asking and deal with those questions, so this issue is needed!

(see also #2026)

@stichbury stichbury added Component: Documentation 📄 Issue/PR for markdown and API documentation and removed Component: Documentation 📄 Issue/PR for markdown and API documentation labels Nov 29, 2022
@merelcht
Copy link
Member Author

merelcht commented May 9, 2023

Closing this as FAQs are now on the Website.

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

No branches or pull requests

2 participants