diff --git a/docs/pephub/img/github_orgs.png b/docs/pephub/img/github_orgs.png new file mode 100644 index 00000000..13224bc7 Binary files /dev/null and b/docs/pephub/img/github_orgs.png differ diff --git a/docs/pephub/user/organization.md b/docs/pephub/user/organization.md new file mode 100644 index 00000000..e5986603 --- /dev/null +++ b/docs/pephub/user/organization.md @@ -0,0 +1,19 @@ +# PEPhub organizations + +PEPhub allows users to create and manage PEPs within an organization. PEPhub organizations are linked to GitHub +organizations, and all members of a linked GitHub organization are designated as admins for the projects in the +corresponding PEPhub organization. By default, all projects in a PEPhub organization are public. However, admins +can make projects private, restricting visibility to members of the organization. + +### Logging in +When you log in to PEPhub through GitHub, all your organizations are fetched, and you are automatically added as an admin. + +!!! warning "Warning!" + PEPhub currently does not support GitHub user organizations that are set to private (hidden) in the user settings. + +!!! tip "Set GitHub org Membership Visibility" + + 1. Go to the GitHub page. + 2. Navigate to the organization’s page. (e.g. https://github.com/databio) + 3. Click People (in the organization's menu bar). + 4. Locate your username and ensure your membership is public.![../img/github_orgs.png](../img/github_orgs.png) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 76a8f967..9b070312 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,7 +51,7 @@ markdown_extensions: custom_fences: - name: mermaid class: mermaid - format: "!!python/name:pymdownx.superfences.fence_code_format" + format: !!python/name:pymdownx.superfences.fence_code_format extra_css: - stylesheets/extra.css @@ -179,6 +179,7 @@ nav: - How to use views: pephub/user/views.md - PEP of PEPs (POP): pephub/user/pops.md - Accessing GEO metadata: pephub/user/geo.md + - PEPhub organization: pephub/user/organization.md - PEPHubClient: - PEPhubClient: pephub/user/pephubclient/README.md - Quickstart: pephub/user/pephubclient/tutorial.md