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

Prepare Good Readme , Installation documentation #113

Closed
kshitijrajsharma opened this issue May 23, 2023 · 11 comments
Closed

Prepare Good Readme , Installation documentation #113

kshitijrajsharma opened this issue May 23, 2023 · 11 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Issues that welcome contributions priority:medium

Comments

@kshitijrajsharma
Copy link
Member

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

@kshitijrajsharma kshitijrajsharma added documentation Improvements or additions to documentation priority:medium enhancement New feature or request labels May 23, 2023
@petya-kangalova petya-kangalova added the good first issue Issues that welcome contributions label May 30, 2023
@petya-kangalova
Copy link
Contributor

petya-kangalova commented Jun 5, 2023

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)

Sorry, something went wrong.

@petya-kangalova
Copy link
Contributor

Adding photos here on general workflow to be used in the docs.
Flowchart (3)
Flowchart (2)

@kshitijrajsharma
Copy link
Member Author

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

@petya-kangalova
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Member Author

@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
Copy link
Contributor

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
Copy link
Contributor

image

So far I only see these .md so far

@petya-kangalova
Copy link
Contributor

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
Copy link
Contributor

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.

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 enhancement New feature or request good first issue Issues that welcome contributions priority:medium
Projects
None yet
Development

No branches or pull requests

3 participants