Skip to content

Commit 08e48b1

Browse files
authored
Merge pull request #85 from django-commons/update-readthedocs
add readthedocs
2 parents 556f5aa + ee7cbf3 commit 08e48b1

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ Assuming the repository name is `repo-name`:
133133

134134
### Pre Transfer Steps
135135

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

149149
These should be done by the project owner.
150150

151+
- [ ] Invite djangocommons@gmail.com to the [readthedocs project][readthedocs] as a maintainer, so the Django Commons
152+
admins can manage the readthedocs project.
151153
- [ ] Transfer the existing repository to the Django Commons organization using the GitHub UI, so old
152154
information is preserved. See [GitHub docs][gh-docs-transfer-repo].
153155
- It takes GitHub a couple minutes to process the move, therefore it is highly recommended to do this step first.
@@ -270,7 +272,7 @@ The expected changes:
270272
271273
[2]: https://github.com/django-commons/membership/blob/main/terraform/production/repositories.tfvars
272274
273-
[3]: https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md
275+
[incoming-requirements]: https://github.com/django-commons/membership/blob/main/incoming_repo_requirements.md
274276
275277
[people]: https://github.com/orgs/django-commons/people
276278
@@ -296,4 +298,6 @@ The expected changes:
296298
297299
[project-checkins-discussions]: https://github.com/orgs/django-commons/discussions/categories/check-ins
298300
299-
[pypi-org]: https://pypi.org/manage/organization/django-commons/projects/
301+
[pypi-org]: https://pypi.org/manage/organization/django-commons/projects/
302+
303+
[readthedocs]: https://readthedocs.org/

0 commit comments

Comments
 (0)