Prepare Good Readme , Installation documentation

[kshitijrajsharma]

This issue is about documentation plan is to prepare a best way to communicate what fair is what it does , its potential and current stage so that people landing to github will get the gist idea 💡 ! Also we can separate installation doc for developers, also we can explain other smaller modules that fair is using such as fair utilities

[petya-kangalova]

Adding a bit more info about the documentation:

• Complete the community checklist https://github.com/hotosm/fAIr/community
  Detailed documentation targeted for :
• Initial users who knows nothing about fair and landed into github site !
• Technical users who knows about ML but not about fAIr and interested on knowing more
• Developers : Installation docs ( this can be separated)

[petya-kangalova]

Adding photos here on general workflow to be used in the docs.

[kshitijrajsharma]

Reference : https://www.hotosm.org/tech-blog/hot-tech-talks-fair/

[petya-kangalova]

Reference to presentation that can be used for history/background of fAIr in readme file: https://docs.google.com/presentation/d/1kR2Gezh3yOhEZBSjtoJR37rJ1JX9Q3m6T43BO55puIU/edit#slide=id.g17a6951e02b_0_26

[petya-kangalova]

Thanks to those of you who joined the HOT Open Tech and Inno session earlier today where I talked about this specific issue! Some people asked about example of similar docs from other repo- FMTM is one you can use for reference, where we have used Wiki . Please comment on the issue if you are interested in collaborating and helping us with creating documentation!

[chrischank]

Hi @petya-kangalova and @kshitijrajsharma sorry for missing voluntary session again, think I finally found the documentation issue pages, are there currently a table for tracking what needs or not needs to be documented still? How can we slot ourselves in, do we create a temporary doc branches when writing readme etc...

[kshitijrajsharma]

@chrischank Not yet ! Initial plan is to let user know all about fAIr what we trying to achieve and what our current position is ! We can start by creating fork / branch start with .md file , Can modify existing readme.md pr introduce new .md file whichever is easy to read when user lands to fAIr github repo !

[chrischank]

I guess what you would want is a readme.md per application or module right with a template and then that readme.md is assigned to a volunteer or a staff to work on based on understanding of the existing code?

[chrischank]

So far I only see these .md so far

[petya-kangalova]

looping in @neelimagoogly as she is currently working on the docs #127. The idea is to create them as Github Wiki Pages. I am speaking with Neelima at 13:00UTC today about this- @chrischank you're welcome to join if you're free to discuss collaborating on this.

[petya-kangalova]

After discussion with @neelimagoogly and @chrischank we agreed to split into three issues:
#128
#129
#130

I am closing this one as work will continue in the above issues.