Skip to content

Commit

Permalink
added docs about pephub organizations
Browse files Browse the repository at this point in the history
  • Loading branch information
khoroshevskyi committed Dec 5, 2024
1 parent 34944e6 commit c4f4acc
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
Binary file added docs/pephub/img/github_orgs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/pephub/user/organization.md
Original file line number Diff line number Diff line change
@@ -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)
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c4f4acc

Please sign in to comment.