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

Improve BACKEND readme file #129

Open
petya-kangalova opened this issue Jul 5, 2023 · 5 comments
Open

Improve BACKEND readme file #129

petya-kangalova opened this issue Jul 5, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Issues that welcome contributions

Comments

@petya-kangalova
Copy link
Contributor

Review existing readme file and suggest improvement to the documentation https://github.com/hotosm/fAIr/blob/master/backend/README.md

Plan is to first improve in current location and then decide if to move to Wiki and agree structure. @chrischank to work on this! Thank youuuu

@petya-kangalova petya-kangalova added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 5, 2023
@petya-kangalova petya-kangalova added the good first issue Issues that welcome contributions label Jul 5, 2023
@chrischank
Copy link
Contributor

Unfortunately my laptop had been broken down one day after we met. I'll only receive my new laptop on Monday. Hope this issue is not in too much of a rush

@petya-kangalova
Copy link
Contributor Author

hi @chrischank no worries at all and we are not in a rush. Hope you receive the laptop today and all gets sorted.

@petya-kangalova
Copy link
Contributor Author

@chrischank how is the work going on the backed docs? Can you link to any PRs if ready? Keep us posted. We had some other volunteers message to see if they can input into documentation so wanted to check where you have gone to.

@chrischank
Copy link
Contributor

HI @petya-kangalova so I have been struggling to recreate and rebuild the docker images with MacOS and Arch Linux, so I can only write, what I can do and know given limited experiment. I felt like the readme therefore is incomplete. In addition, I am waiting for the infographics review whether I am missing something or not. Here is my forked repo backend_readme.md so far. Will make a pull requests once the diagram is reviewed

https://github.com/chrischank/fAIr/blob/backend_doc/backend/backend_README.md

@petya-kangalova
Copy link
Contributor Author

Hi @chrischank thank you for the update and appreciate the work you have done. @omranlm @kshitijrajsharma can you assist with the diagram review?

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
Projects
None yet
Development

No branches or pull requests

2 participants