Badgeyay: Remove irrelevant data from Backend README.md

Created on 20 Jan 2018  ยท  23Comments  ยท  Source: fossasia/badgeyay

@I'm submitting a ...

  • [ ] bug report
  • [X] feature request

Current behavior:
Unnecessary data shown in backend readme.md file

Expected behavior:
Should be removed

Steps to reproduce:

Documentation Enhancement Help Wanted first-timers-only

Most helpful comment

@S2606 let's open this issue for beginners

All 23 comments

@S2606 let's open this issue for beginners

@S2606 @vaibhavsingh97 @abishekvashok Create a check list of the files to be removed from backend .It will be easy for begginner to follow up from there.

@S2606 @vaibhavsingh97 I'm at a hackathon right now and I wanted to try doing some open source. If you make the check list for files to be removed, I would like to help. This is my first time contributing, so I hope you don't mind if I ask q's along the way! Thanks.

Sure, I will update this issue. Thanks

On Sun 21 Jan, 2018, 4:17 AM Sabrina Tsui, notifications@github.com wrote:

@S2606 https://github.com/s2606 @vaibhavsingh97
https://github.com/vaibhavsingh97 I'm at a hackathon right now and I
wanted to try doing some open source. If you make the check list for files
to be removed, I would like to help. This is my first time contributing, so
I hope you don't mind if I ask q's along the way! Thanks.

โ€”
You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub
https://github.com/fossasia/badgeyay/issues/499#issuecomment-359208181,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AITVapgwaCdsPNLf6533uIpbgxqSzx1mks5tMm0ZgaJpZM4RleTQ
.

@sctsui Your questions are encouraged.
Welcome to FOSSASIA :smile:

@sctsui you need to change the readme.md in backend and remove any unwanted docs which are not specific to the backend from it.

Are you still working on this @S2606

i want to help fixing this issue. I cant find the checklist for the irrelevant data .. plz help I am new to open source

@S2606 @vaibhavsingh97 @abishekvashok @yashLadha Please create a checklist of the files which are to be removed ๐Ÿ‘

It's not the files but irrevalend data in backend/Readme.md that needs to be removed.

I think all the README (Except installation README) needs to be updated according to the new project structure.

* To be done *:

  • 3rd point needs to be modified in introduction section as now user have to enter 5 entries, instead of earlier 4.
  • Remove Usage section, since Vagrant setup is available now. User Input Guide is not required either now.
  • Fix installation links to correct location.
  • Fix implementation links to correct location.
  • Fix a link in maintainers section with text Badgeyay.

I would like to claim it if no beginner takes up the issue in coming few days. If its fine for you guys @yashLadha @vaibhavsingh97 @raju249 @S2606 @abishekvashok @ParthS007 ?

Yea it looks good. @rupav

:+1: @rupav

@rupav Can I take up this issue?

@Minkush-sopho yes, go ahead ๐Ÿ‘

@rupav ok sir

@Minkush-sopho no "sir" please ๐Ÿ˜…

@rupav ohk :)

@rupav Can you please suggest what needs to be added as the 5th field in introduction section's 3rd point?

@Minkush-sopho as per https://github.com/fossasia/badgeyay/pull/476 it should be Designation field.

@rupav thanks ๐Ÿ‘

Was this page helpful?
0 / 5 - 0 ratings

Related issues

niccokunzmann picture niccokunzmann  ยท  6Comments

meets2tarun picture meets2tarun  ยท  8Comments

mariobehling picture mariobehling  ยท  7Comments

niccokunzmann picture niccokunzmann  ยท  7Comments

mariobehling picture mariobehling  ยท  6Comments