Our README is not very useful and outdated. It should send users to read jsonapi.api.php and our extensive online documentation instead of trying to provide any actionable information.

CommentFileSizeAuthor
#9 interdiff.txt395 bytesgabesullice
#7 interdiff-3003148-3-7.txt2.05 KBabhisekmazumdar
#7 updated-readme-3003148-7.patch1.61 KBabhisekmazumdar
#3 updated-readme-3003148-3.patch1.76 KBabhisekmazumdar

Comments

gabesullice created an issue. See original summary.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented

Good call!

abhisekmazumdar’s picture

abhisekmazumdar
he/him
Primary language English
Location India
commented
Status: Active » Needs work
StatusFileSize
new updated-readme-3003148-3.patch1.76 KB

Hy,
I hope this README.me will serve the purpose.
Thank You

abhisekmazumdar’s picture

abhisekmazumdar
he/him
Primary language English
Location India
commented
Status: Needs work » Needs review
izus’s picture

izus commented
Status: Needs review » Reviewed & tested by the community

Hi,
#3 seems good to me
Thanks

gabesullice’s picture

gabesullice
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

Hi @abhisekmazumdar and @izus! Thanks for your help here!

I don't think that this patch addresses the issue summary.

The IS says:

It should send users to read jsonapi.api.php and our extensive online documentation

To clarify, the README should explicitly tell readers to instead read the jsonapi.api.php file for a summary about what JSON API does.

Then, it should point readers to https://www.drupal.org/docs/8/modules/json-api/json-api, where they'll find extensive documentation.

abhisekmazumdar’s picture

abhisekmazumdar
he/him
Primary language English
Location India
commented
Status: Needs work » Needs review
StatusFileSize
new updated-readme-3003148-7.patch1.61 KB
new interdiff-3003148-3-7.txt2.05 KB

Hi @gabesullice
Thanks for the clarification, I have done the changes as you suggested.
Please review.
Thank You

gabesullice’s picture

gabesullice
Primary language English
commented
Status: Needs review » Fixed
StatusFileSize
new interdiff.txt395 bytes

@abhisekmazumdar++

Given that this is a simple README change and @Wim Leers already +1'd the idea, I just went ahead and committed it.

I made a little change on commit. See the interdiff.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.