Improving Documentation

atalyaalon commented 3 years ago

This issue will accompany us for 2-3 milestones - will try improving the following documentation:

[x] ANYWAY Products (+ Overview Diagram)
[ ] ANYWAY Teams
[ ] ANYWAY communication
[x] BackEnd Current Architecture
[ ] DB Tables documentation
[ ] New flash flow (insertion, classification and location extraction)
[ ] Infographics data creation flow
[ ] DB dump process - both partial (for dev) and full (for backup) (including needed actions for adding a table that will be removed in partial dump)

Nowadays we have some documentation docs dir - and some in github wikis Consider either using github wikis OR use gitbook instead

@BarVolunteering @ziv17 @assafdayan what else are we missing on that list? Any thoughts?

BarVolunteering commented 3 years ago

If we use github wikis then the changes in the docs won't be in the pull request of the changed code. Other then that it seems good.

ziv17 commented 3 years ago

Development environment Vs. Production Vs testing. Flows of adding data The static folder.

data-for-change / anyway