└── README.md


/README.md:
--------------------------------------------------------------------------------
 1 | # sphinx-contrib GitHub Administration
 2 | 
 3 | This repository is used for managing the sphinx-contrib GitHub organization, including requesting importing new repositories or granting permissions.
 4 | 
 5 | ## How do I add a new repo to sphinx-contrib?
 6 | 
 7 | 1. Create the repository elsewhere, such as under your personal account.
 8 | 2. File a ticket [here](https://github.com/sphinx-contrib/github-administration/issues) asking to join the organization, including a link to the repository being added.
 9 | 3. Accept the invitation to join the organization.
10 | 4. Use the GitHub UI to move the repository into the organization (you will need administrator/owner rights on the repository to do this). See [the GitHub documentation on repository transfer](https://help.github.com/en/github/administering-a-repository/transferring-a-repository) for details.
11 | 5. After it is moved, rename the repository to remove prefixes like `sphinx`, `sphinx-contrib`, and `sphinxcontrib`. Don't forget to update the documentation in the repository, too!
12 | 
13 | ## How do I add a project to the sphinx-contrib PyPI organization?
14 | 
15 | In addition to adding the project on the `sphinx-contrib` GitHub organization, you may also wish to add it to the [`sphinx-contrib` PyPI organization](https://pypi.org/org/sphinx-contrib/).
16 | This is optional, and the main advantage is that it allows for the appointment of new maintainers should you no longer wish to be involved in the project/not be available.
17 | 
18 | > [!NOTE]
19 | > We will not add new maintainers to a project without attempting to reach out to the original maintainers via all available methods.
20 | 
21 | 1. Ask to be invited to the organization, either when transferring project(s) or by opening a new issue.
22 | 2. Add the `sphinx-contrib` *user* to the project(s) in question. This is a meta account managed by @stephenfin that allows us to actually add a project, in the absence of a transfer request mechanism.
23 | 
24 | Once these steps are done, you will be added as a member to the `sphinx-contrib` *organization*, and project will be moved to this organization.
25 | 


--------------------------------------------------------------------------------