PEP 755: minor touchups (#3951)

This commit is contained in:
Ofek Lev 2024-09-07 12:26:14 -04:00 committed by GitHub
parent 144038b5b8
commit de6c462335
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 7 deletions

View File

@ -106,6 +106,14 @@ common will be persisted internally for future reviewers to reference and new
applications attempting to reserve a namespace that was previously rejected
for that reason will display a warning.
Acceptance
''''''''''
When an application is accepted for a namespace that is used by projects
outside of the organization, an email will be sent to the owners of the
projects notifying them of the new grant. The email will contain a link to the
`namespace's page <namespace-page_>`_.
Grant Types
-----------
@ -149,8 +157,18 @@ permitted organizations are transferred as well.
User Interface
--------------
Prefix
''''''
.. _namespace-page:
Namespace Page
''''''''''''''
The namespace of every active grant will have its own page that has information
such as its :pep:`open <752#open-namespaces>` status, the current owners, the
time at which ownership was granted and the total number of projects that match
the namespace.
Project Page
''''''''''''
Every project's page
(`example <https://pypi.org/project/google-cloud-compute/1.19.2/>`__) that
@ -159,9 +177,8 @@ currently does not do this) and will stand out as a pill or label. This value
will match the ``prefix`` key in the
:pep:`namespace detail API <752#namespace-detail>`.
Clicking on the namespace will take the user to a page that has more
information such as the current owners, the time at which ownership was granted
and the total number of projects that match the namespace.
Clicking on the namespace will take the user to
`its page <namespace-page_>`_.
Visual Indicators
'''''''''''''''''
@ -209,8 +226,9 @@ following circumstances:
* The organization manually removes themselves as the owner.
* The organization is deleted.
When a reserved namespace becomes unclaimed, matching projects will no longer
have a `visual indicator <user-interface_>`_.
When a reserved namespace becomes unclaimed, the `UI <user-interface_>`_ will
reflect this such that matching projects will no longer have any indicators on
their page nor will the namespace have a dedicated page.
How to Teach This
=================