readthedocs / readthedocs/common
wrangler: ability to serve addons from local development
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 48
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 5
Description
The idea would be to call inv docker.up --addons-local-dev or similar and make the CF worker to inject http://localhost:8000/readthedocs-addons.js instead of the /_/static/ URL.
See https://github.com/readthedocs/readthedocs.org/pull/10965#discussion_r1479728044 for more context.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the inv docker.up entry point and the linked pull request discussion for how local development currently serves the addon script. Trace where the CF worker chooses the /_/static/ URL and determine how an --addons-local-dev option should select the localhost URL. Done means local development can enable this behavior without changing the default URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100