react-google-maps-api icon indicating copy to clipboard operation
react-google-maps-api copied to clipboard

Link to official docs broken

Open sohaibfurqan92 opened this issue 2 years ago • 18 comments

The link to the official docs appears to be broken. When I go to https://react-google-maps-api-docs.netlify.app/

I get the following screen:

image

sohaibfurqan92 avatar Jul 16 '23 14:07 sohaibfurqan92

https://github.com/JustFly1984/react-google-maps-api/issues/3256#issuecomment-1636179725

dreamboat999 avatar Jul 16 '23 15:07 dreamboat999

having the some issue for quite some time.

shahria7k avatar Jul 16 '23 20:07 shahria7k

It seems they have downed the hosting from this - https://github.com/JustFly1984/react-google-maps-api/issues/3256#issuecomment-1636175731 Is there any alternative link for this doc?

Hi, @JustFly1984 Could you please restore the deployment again? Everyone would be wary of entering the API key directly into the documentation. I think there are many people who need this doc.

Crimsonyx412 avatar Jul 17 '23 17:07 Crimsonyx412

I agree, it is difficult to use this package without any documentation

ben-roth- avatar Jul 17 '23 18:07 ben-roth-

I am unable to use your package without docs, so kindly restore official doc links

amjad-awan avatar Jul 17 '23 18:07 amjad-awan

Hopefully someone gets this fixed, I am using this in the mean time: https://web.archive.org/web/20230701010714/https://react-google-maps-api-docs.netlify.app/ Not perfect, but it works. Hopefully we can get this issue resolved soon.

@amjad-awan @ben-roth- @Crimsonyx412 @shahria7k

neatstranger avatar Jul 17 '23 21:07 neatstranger

Yes, now okay. Thank you

amjad-awan avatar Jul 19 '23 13:07 amjad-awan

Docs are the part of packages/react-google-maps-api run docs with yarn docs:dev locally and build with yarn docs:build

If somebody want to fix it, your PR is welcome

JustFly1984 avatar Jul 26 '23 16:07 JustFly1984

I am sorry to say that if you own a repo you should also be responsible for the docs page to be up ... just my 2 cents.

chris-iliopoulos avatar Jul 26 '23 20:07 chris-iliopoulos

@JustFly1984 Okay forgive me for being ignorant, but what language/framework are the docs built in? I can try to take a crack at it in my free time this week if I run into some. Also is there somewhere that the specific issue is documented?

neatstranger avatar Jul 26 '23 21:07 neatstranger

@JustFly1984 Okay forgive me for being ignorant, but what language/framework are the docs built in? I can try to take a crack at it in my free time this week if I run into some. Also is there somewhere that the specific issue is documented?

image

something with infinite API calls

docs are built in react I believe

Issue found here: https://github.com/JustFly1984/react-google-maps-api/issues/3256#issuecomment-1636179725

ezerssss avatar Jul 29 '23 16:07 ezerssss

@chris-iliopoulos never use wording "Should" in the context of Open Source. Nobody owes nobody nothing. I can say that you "Should" consider to donate to every open source library you use starting with this one. But who cares)

JustFly1984 avatar Jul 31 '23 05:07 JustFly1984

@neatstranger If you look into packages/react-google-maps-api/package.json, you'll see

 "react-docgen": "6.0.2",
 "react-docgen-typescript": "2.2.2",
 "react-styleguidist": "13.1.1",

react-docgen for a while was unmaintained and not compatible with react 17+, but I had to make library compatible, so docs was abandoned and failed to build.

JustFly1984 avatar Jul 31 '23 05:07 JustFly1984

If somebody wants to have docs, you'll have to fix react-docgen, react-docgen-typescript and react-styleguidist config yourself.

JustFly1984 avatar Jul 31 '23 06:07 JustFly1984

https://github.com/JustFly1984/react-google-maps-api/issues/3256

JustFly1984 avatar Aug 01 '23 09:08 JustFly1984

@JustFly1984 What caused the issue that makes the docs deployments down on Netlify? I'd like to try and help fix the issue. thanks

zourdyzou avatar Aug 01 '23 12:08 zourdyzou

Until this issue is fixed we can use this as a temporary solution.

https://web.archive.org/web/20230701010714/https://react-google-maps-api-docs.netlify.app/

sohanemon avatar Sep 10 '23 06:09 sohanemon