You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ topics:
16
16
shortTitle: Organization's profile
17
17
---
18
18
19
-
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 %}
19
+
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 %}
20
20
21
21
{% ifversion fpt %}
22
22
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.
intro: You can share information about your organization by customizing your organization's profile
3
+
intro: You can share information about your organization by customizing your organization's profile.
4
4
versions:
5
5
fpt: '*'
6
6
ghec: '*'
@@ -11,19 +11,70 @@ topics:
11
11
shortTitle: Customize organization profile
12
12
---
13
13
14
-
## About your organization's profile README
14
+
{% if org-profile-pin-private %}
15
15
16
-
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.
16
+
## About your organization's profile page
17
17
18
-
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.
18
+
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.
19
+
20
+
21
+
{% endif %}
22
+
23
+
### Pinned repositories
24
+
25
+
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.
26
+
27
+
Only organization owners can pin repositories. For more information, see "[Pinning repositories to your organization's profile](#pinning-repositories-to-your-organizations-profile)."
28
+
29
+
### Organization profile READMEs
30
+
31
+
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.
32
+
33
+
You can choose what information to include in your organization profile README. Here are some examples of information that may be helpful.
19
34
20
35
- An "About" section that describes your organization
21
36
- Guidance for getting help in the organization
22
37
23
38
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)."
24
39
25
-
## Adding an organization profile README
40
+
## Adding a public organization profile README
26
41
27
42
1. If your organization does not already have a public `.github` repository, create a public `.github` repository.
28
43
2. In your organization's `.github` repository, create a `README.md` file in the `profile` folder.
29
-
3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's profile.
44
+
3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's public profile.
45
+
46
+
47
+
48
+
{% if org-profile-pin-private %}
49
+
50
+
## Adding a member-only organization profile README
51
+
52
+
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.
53
+
2. In your organization's `.github-private` repository, create a `README.md` file in the `profile` folder.
54
+
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.
55
+
56
+
57
+
58
+
## Pinning repositories to your organization's profile
59
+
60
+
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.
61
+
62
+
1. Navigate to your organization's profile page.
63
+
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.
64
+
65
+
66
+
67
+
3. In the pinned repositories section, select **Customize pins**.
68
+
69
+
70
+
71
+
- 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.
72
+
73
+
74
+
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.
75
+
76
+
0 commit comments