Develop consistent method for capturing FAQs / common errors across all PDS repositories #21
Description
💡 Description
Looking for a standard way to capture FAQs and common errors for each of the components of the system.
These are often dynamic and we want to be able to change these quickly based upon some comments from users, so we do not want this to be in our online documentation where we have to tag a new release and deploy the docs anytime something new comes up.
Let's use this thread to come up with some ideas.
a. We use each repos Wiki to capture these - PRO - it's easy to do and consistent across repos. CON - people don't really notice those wikis being there, and the revision history isn't readily accessible (you can checkout the wiki repo but just not as clean)
b. We have an FAQs.md at the top of every repo - includes both FAQs and a separate section for Common Errors, we just update this file and link to it from our online docs.
c. We use each repos Github Discussions - would encourage folks from the community to potentially participate, but not as refined as an explicit file or wiki page curated by the repos committers/PMC.