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

Known issues section for FLINT installation. #107

Open
shloka-gupta opened this issue Aug 30, 2021 · 3 comments
Open

Known issues section for FLINT installation. #107

shloka-gupta opened this issue Aug 30, 2021 · 3 comments

Comments

@shloka-gupta
Copy link
Member

The issue:
While setting up FLINT people face general issues.
Most of these issues occur regularly and get solved on slack. This leads to the solution getting lost over time.

Solution:

A known issues / FAQ section.
As and when a new person setting up the FLINT faces an issue they can be directed towards this section.

Whenever a newcomer faces an issue and visits this section there are going to be two possibilities:

  1. The issue they are facing exists in the section with the solution - This will solve their problem.
  2. The issue they are facing is not present in the section. - The person facing the issue can add the issue and solution to the section once it gets solved on slack.
@shloka-gupta
Copy link
Member Author

Hello,
@sarahhaggarty, @shubhamkarande13, and @HarshCasper
Do let me know your opinions.
And, also the standard name for this section? I think I have got the name wrong.

@shloka-gupta shloka-gupta changed the title Known issues section. Known issues section for FLINT installation. Aug 30, 2021
@sarahhaggarty
Copy link

Hi @chicken-biryani, great idea! What about calling it a "Troubleshooting" section? This can include a FAQ. I think it would be best if known issues were maintained and managed as issues on Github rather than in a Docs section. Then a reader can consult the Github known issues to see if what they are facing is there. If it isn't, they can create a new issue for investigation. What do you think?

@shloka-gupta
Copy link
Member Author

@sarahhaggarty Makes sense. 😄

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

No branches or pull requests

2 participants