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

Outdated Documentation on How to Run and Deploy GFI-Bot #39

Open
hehao98 opened this issue Oct 12, 2022 · 2 comments
Open

Outdated Documentation on How to Run and Deploy GFI-Bot #39

hehao98 opened this issue Oct 12, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation priority: medium

Comments

@hehao98
Copy link
Member

hehao98 commented Oct 12, 2022

Currently, all documentation is severely outdated regarding collecting data, training models, understanding the code structure, and deploy the backend & frontend. My proposal is to create a separate DEVELOPMENT.md in the project root folder to explain how to run and deploy GFI-Bot, with the following sections:

  1. A section to explain the current code structure,
  2. A section to describe the database (and point to the database schemas in gfibot.collections),
  3. A section to introduce how to test new functionalities,
  4. A section to describe how to deploy GFI-Bot and make it autonomously collect data, train models, etc., in a new machine. We can add options to make this process more lightweight, such as limiting the number of projects involved so that GFI-Bot can be easily tested on a local machine.

Then, all outdated content in README.md can be replaced by a link to DEVELOPMENT.md.

@hehao98 hehao98 added documentation Improvements or additions to documentation priority: medium labels Oct 12, 2022
@hrz6976
Copy link
Collaborator

hrz6976 commented Oct 13, 2022

Deployment docs updated in commit 576a5b3

@Sandhya58
Copy link

@hehao98 claim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority: medium
Projects
None yet
Development

No branches or pull requests

3 participants