Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plan work for required .readthedocs.yaml files #316

Closed
nedbat opened this issue Jun 1, 2023 · 3 comments
Closed

Plan work for required .readthedocs.yaml files #316

nedbat opened this issue Jun 1, 2023 · 3 comments
Assignees

Comments

@nedbat
Copy link
Contributor

nedbat commented Jun 1, 2023

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
Copy link

jmbowman commented Jun 5, 2023

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 .

@jmbowman jmbowman changed the title Plan work for required .readthedocs.yml files Plan work for required .readthedocs.yaml files Jun 5, 2023
@zubairshakoorarbisoft zubairshakoorarbisoft self-assigned this Aug 17, 2023
@zubairshakoorarbisoft
Copy link
Contributor

@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 iamsobanjaved moved this from Todo to In Progress in Arbi-BOM Aug 25, 2023
@iamsobanjaved
Copy link
Member

@github-project-automation github-project-automation bot moved this from In Progress to Done in Arbi-BOM Aug 25, 2023
@jristau1984 jristau1984 moved this from Done to Done - Long Term Storage in Arbi-BOM Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done - Long Term Storage
Development

No branches or pull requests

4 participants