badges/shields

Badge Request: Support ReadTheDocs Business Tiers

Open

#8335 opened on Aug 23, 2022

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

: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.

Contributor guide

Tech stack
javascriptnodejs
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic JavaScriptFamiliarity with Shields service architectureUnderstanding of ReadTheDocs API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding support for ReadTheDocs Business tiers (readthedocs.com) to the existing badge service. The current implementation for the community tier is in services/readthedocs/readthedocs.service.js. The main task is to extend the service to also handle readthedocs.com URLs, and possibly add authentication for private repositories. Review the existing code to understand the pattern, then add a new base URL and handle the business tier API. The issue comments might contain additional details about API endpoints or token handling.