Skip to content

Commit

Permalink
[Org Profile Internal] Pinned private repos and internal READMEs (git…
Browse files Browse the repository at this point in the history
…hub#27022)

* add toggle section and pinned repo section

* added images and added member readme text

* Optimize images

* Apply suggestions from code review

Co-authored-by: Vanessa <[email protected]>

* update org profile page and customize profile page, adjusted screenshot of custom pinned repos

* Optimize images

* edit images, add versioning + last step

* Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md

Co-authored-by: Daniel Adams <[email protected]>

* final language and setup review

* Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md

Co-authored-by: github-actions <[email protected]>
Co-authored-by: Vanessa <[email protected]>
Co-authored-by: Daniel Adams <[email protected]>
Co-authored-by: hubwriter <[email protected]>
  • Loading branch information
5 people authored Apr 20, 2022
1 parent f3055d0 commit 1a986dd
Show file tree
Hide file tree
Showing 10 changed files with 65 additions and 7 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ topics:
shortTitle: Organization's profile
---

You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %}
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's public profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %}

{% ifversion fpt %}
Organizations that use {% data variables.product.prodname_ghe_cloud %} can confirm their organization's identity and display a "Verified" badge on their organization's profile page by verifying the organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)" in the {% data variables.product.prodname_ghe_cloud %} documenatation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Customizing your organization's profile
intro: You can share information about your organization by customizing your organization's profile
intro: You can share information about your organization by customizing your organization's profile.
versions:
fpt: '*'
ghec: '*'
Expand All @@ -11,19 +11,70 @@ topics:
shortTitle: Customize organization profile
---

## About your organization's profile README
{% if org-profile-pin-private %}

You can share information about how to engage with your organization by creating an organization profile README. {% data variables.product.prodname_dotcom %} shows your organization profile README in the "Overview" tab of your organization.
## About your organization's profile page

You can choose what information to include your organization profile README. Here are some examples of information that may be helpful in your organization's profile README.
You can customize your organization's Overview page to show content dedicated to public users or members of the organization. Members of your organization who are signed into {% data variables.product.prodname_dotcom %}, are shown a member view when they visit your organization's profile page. Users who are not members of your organization will be shown a public view.

![Image of an organization profile page](/assets/images/help/organizations/new_organization_page.png)
{% endif %}

### Pinned repositories

You can give users easy access to important or frequently used repositories, by choosing up to six repositories for public users and six repositories for members of the organization. Once you pin repositories to your organization profile, the "Pinned" section is shown above the "Repositories" section of the profile page.

Only organization owners can pin repositories. For more information, see "[Pinning repositories to your organization's profile](#pinning-repositories-to-your-organizations-profile)."

### Organization profile READMEs

You can share information about how to engage with your organization by creating an organization profile README for both public users and members of the organization. {% data variables.product.prodname_dotcom %} shows your organization profile README in the "Overview" tab of your organization.

You can choose what information to include in your organization profile README. Here are some examples of information that may be helpful.

- An "About" section that describes your organization
- Guidance for getting help in the organization

You can format text and include emoji, images, and GIFs in your organization profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)."

## Adding an organization profile README
## Adding a public organization profile README

1. If your organization does not already have a public `.github` repository, create a public `.github` repository.
2. In your organization's `.github` repository, create a `README.md` file in the `profile` folder.
3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's profile.
3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's public profile.

![Image of an organization's public README](/assets/images/help/organizations/org_public_readme.png)

{% if org-profile-pin-private %}

## Adding a member-only organization profile README

1. If your organization does not already have a `.github-private` repository, create a public `.github-private` repository. This action can be performed by any user that has write access to that repository.
2. In your organization's `.github-private` repository, create a `README.md` file in the `profile` folder.
3. Commit the changes to the `README.md` file. The content of the `README.md` will be displayed in the member view of your organization's profile.

![Image of an organization's private README](/assets/images/help/organizations/org_member_readme.png)

## Pinning repositories to your organization's profile

You can pin repositories that you want to feature, such as those that are frequently used, to your organization's profile page. To choose which repositories to pin to your organization's profile, you must be an organization owner or administrator.

1. Navigate to your organization's profile page.
2. In the right sidebar of the page in the {% octicon "eye" aria-label="The eye octicon" %} "View as" link, choose the **Public** or **Member** profile view from the dropdown menu.

![Image of the organization profile view dropdown](/assets/images/help/organizations/org_profile_view.png)

3. In the pinned repositories section, select **Customize pins**.

![Image of the customize pins link](/assets/images/help/organizations/customize_pins_link.png)

- If you haven't yet pinned any repositories to your organization's profile, you'll need to instead click **pin repositories** in the right sidebar of the profile page.
![Image of pin repositories link in right sidebar](/assets/images/help/organizations/pin_repositories_link.png)

4. In the "Edit pinned repositories" dialog box, select a combination of up to six public, {% ifversion not fpt %}private, or internal{% else %}or private{% endif %} repositories to display.

![Image of pinned repo dialog](/assets/images/help/organizations/pinned_repo_dialog.png)

5. Click **Save pins**.

{% endif %}
7 changes: 7 additions & 0 deletions data/features/org-profile-pin-private.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Issue #6171
# Documentation for the "Org profile pin private/internal repos"
versions:
fpt: '*'
ghec: '*'
ghes: '>=3.6'
ghae: 'issue-6171'

0 comments on commit 1a986dd

Please sign in to comment.