search

badges / shields

Concise, consistent, and legible badges in SVG and raster format
https://shields.io
Creative Commons Zero v1.0 Universal
23.8k stars 5.51k forks source link

Badge Request: Support ReadTheDocs Business Tiers #8335

Open rashidnhm opened 2 years ago

rashidnhm commented 2 years ago

:clipboard: Description Currently the support for ReadTheDocs only consist of their free community tier. However, we wanted to use shields to display badges for projects hosted on their Business tiers as well.

:link: Data The data can be fetched very similar to how it is being done currently on the readthedocs service, the main difference here is adding support for readthedocs.com as well.

ReadTheDocs business do support private repositories, getting badges for those may require a token which would be provided by the user.

:microphone: Motivation Use shields with projects hosted on readthedocs.com . Usage of dynamic URLs are not as feasible since the color would be static. And we do not want to standup our own endpoint to get the badge. Supporting this would be a good addition to shields.

chris48s commented 2 years ago

I think the move here is to make the routes

/readthedocs.org/:packageName /readthedocs.com/:packageName

and set up a redirect which maps /readthedocs/:packageName to /readthedocs.org/:packageName

for backwards-compatibility.

For private projects that require a token, is it possible to generate a readthedocs.com token that would not allow access to any sensitive data?

rashidnhm commented 2 years ago

Hello @chris48s

Yes! The token is actually something that is auto-generated by RTD on the project dashboard and it does seem it is scoped to the badge itself only. I have attempted using the token to try and fetch other information from their rest api and got the following response:

{"detail":"Invalid token."}
itsajay1029 commented 2 years ago

Hey @chris48s , can you assign me this issue so that I can get started working on it ?

rashidnhm commented 1 year ago

Hello all, wanted to see if there was any updates regarding this issue?

SakshamShandilya commented 3 months ago

@rashidnhm Can you assign me this issue?

rashidnhm commented 3 months ago

@SakshamShandilya I don't think I have the access to assign the issue to someone. You may need to speak with someone that was write access to this repo