search

edx / edx-arch-experiments

A plugin to include applications under development by the architecture team at edx
GNU Affero General Public License v3.0
0 stars 3 forks source link

Plan work for required .readthedocs.yaml files #316

Closed nedbat closed 1 year ago

nedbat commented 1 year ago

ReadTheDocs is going to require .readthedocs.yaml files in September: https://blog.readthedocs.com/migrate-configuration-v2/

We should plan this work using the Upgrade Project Runbook.

jmbowman commented 1 year ago

Note that the official filename to use for this is now .readthedocs.yaml; usage of such other names such as .readthedocs.yml (which we currently use more often) is deprecated: https://docs.readthedocs.io/en/stable/config-file/index.html .

zubairshakoorarbisoft commented 1 year ago

@iamsobanjaved Findings

Repositories having Version 2 but .yml in OPENEDX org:

  1. xblock
  2. docs.openedx.org
  3. openedx-events
  4. DoneXBlock
  5. ecommerce
  6. django-config-models
  7. xblock-utils
  8. devstack
  9. openedx-webhooks
  10. edx-analytics-dashboard
  11. openedx-aspects
  12. credentials
  13. edx-analytics-data-api

Other places where we might need to make the changes as well: source/developers/how-tos/get-your-project-docs-on-rtd.rst https://github.com/openedx/edx-repo-health/blob/cb3594f14bfcd3cdb19ad820da58f75f30d810ef/tests/fake_repos/no_read_the_docs/.readthedocs.yml#L4 https://github.com/openedx/edx-repo-health/blob/cb3594f14bfcd3cdb19ad820da58f75f30d810ef/tests/fake_repos/read_the_docs/.readthedocs.yml#L4

Repositories having Version 2 but .yml in EDX org: dbt-schema-builder commerce-coordinator platform-plugin-notices edx-name-affirmation program-intent-engagement getmaster-api-client

Other places where we might need to make the changes as well: https://github.com/edx/repo-health-data/blob/25e2d333ca990b3f94022715af573130c59bad7c/docs/checks_metadata.yaml#L136

iamsobanjaved commented 1 year ago

Created tickets for further action: