readthedocs/readthedocs.org

Development: update initial fixture

Open

#8,914 opened on Feb 14, 2022

View on GitHub
 (13 comments) (0 reactions) (0 assignees)Python (7,765 stars) (3,748 forks)batch import
AcceptedGood First IssueImprovement

Description

We are loading test_data.json from https://github.com/readthedocs/readthedocs.org/blob/40bc5b1c01a8edfcaf4b898e5b79565598e36d51/readthedocs/projects/fixtures/test_data.json when running inv docker.up --init at https://github.com/readthedocs/common/blob/0620e5dad7831c8c6d093efb7e5c91d8118d9c61/dockerfiles/entrypoints/web.sh#L11

That fixture contains some projects that are old or are abandoned and are not good test cases to have under the development environment. It would be good to update them with better projects for testing. Those project includes test-builds, docs, sphinx-notfound-page, sphinx-hoverxref, blog and some other projects maintained by the community, like poliastro, geopandas, godot, numpy, xarray, sphinx, etc.

Contributor guide

Tech stack
pythondocker
Domain
backenddeveloper experiencetesting
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Django fixturesFamiliarity with readthedocs development setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the current test data.json fixture at the linked path to understand its structure and the projects it includes. Identify which projects are outdated or abandoned, and replace them with suggested active projects like poliastro, geopandas, or numpy. Ensure the new fixtures work with the development environment by testing with `inv docker.up init`. Consult the issue's comments for any additional guidance or preferences from maintainers.