Skip to content

add readthedocs #85

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

Merged
merged 1 commit into from
Jun 18, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Assuming the repository name is `repo-name`:

### Pre Transfer Steps

- [ ] Check if the repository meets [inbound requirements][3].
- [ ] Check if the repository meets [inbound requirements][incoming-requirements].
- [ ] A PR to add the [release workflow][release-gh-workflow] will be necessary. This can be done either by the repo
owner OR the Django commons org admins, but should be done prior to the video call. The decision is up to the repo
owner.
Expand All @@ -148,6 +148,8 @@ Assuming the repository name is `repo-name`:

These should be done by the project owner.

- [ ] Invite djangocommons@gmail.com to the [readthedocs project][readthedocs] as a maintainer, so the Django Commons
admins can manage the readthedocs project.
- [ ] Transfer the existing repository to the Django Commons organization using the GitHub UI, so old
information is preserved. See [GitHub docs][gh-docs-transfer-repo].
- It takes GitHub a couple minutes to process the move, therefore it is highly recommended to do this step first.
Expand Down Expand Up @@ -270,7 +272,7 @@ The expected changes:

[2]: https://github.com/django-commons/membership/blob/main/terraform/production/repositories.tfvars

[3]: https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md
[incoming-requirements]: https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md

[people]: https://github.com/orgs/django-commons/people

Expand All @@ -296,4 +298,6 @@ The expected changes:

[project-checkins-discussions]: https://github.com/orgs/django-commons/discussions/categories/check-ins

[pypi-org]: https://pypi.org/manage/organization/django-commons/projects/
[pypi-org]: https://pypi.org/manage/organization/django-commons/projects/

[readthedocs]: https://readthedocs.org/