Skip to content

Commit f313d7b

Browse files
jc-clarkCopilot
andauthored
[EDI] Update the Customize your profile map topic and other profile docs (#57613)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 9c99bc6 commit f313d7b

File tree

7 files changed

+120
-128
lines changed

7 files changed

+120
-128
lines changed
Lines changed: 69 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: About your profile
33
shortTitle: Personal profile
4-
intro: 'Your profile page tells people your story through the information you share, the contributions you make, and the projects you showcase.'
4+
intro: 'Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.'
55
redirect_from:
66
- /articles/viewing-your-feeds
77
- /articles/profile-pages
@@ -16,29 +16,79 @@ versions:
1616
topics:
1717
- Profiles
1818
---
19-
You can tell other people a little bit about yourself by writing a bio. With the help of [@mentions](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. The bio field is limited to 160 characters.
2019

21-
For a longer-form and more prominent way of displaying customized information about yourself, you can create a profile README. If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page.
2220

23-
If you have the activity overview section enabled for your profile and you @mention an organization you're a member of in your profile bio, then that organization will be featured first in your activity overview.
21+
Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.
2422

25-
![Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.](/assets/images/help/repository/profile-with-readme.png)
23+
{% data reusables.profile.profile-visibility %}
2624

27-
People who visit your profile can also see:
25+
## Key profile elements
2826

29-
* A timeline of your contribution activity, like issues and pull requests you've opened, commits you've made, and pull requests you've reviewed
30-
* Repositories and gists you own or contribute to. You can showcase your best work by pinning repositories and gists to your profile.
31-
* Repositories you've starred{% ifversion fpt or ghec %} and organized into lists{% endif %}
32-
* An overview of your activity in organizations, repositories, and teams you're most active in{% ifversion fpt or ghec %}
33-
* Badges and Achievements that highlight your activity and show if you use {% data variables.product.prodname_pro %} or participate in programs like the {% data variables.product.prodname_arctic_vault %}, {% data variables.product.prodname_sponsors %}, or the {% data variables.product.company_short %} Developer Program{% endif %}
34-
{%- ifversion profile-pronouns %}
35-
* Your pronouns (if you have set them)
36-
{%- endif %}
37-
{%- ifversion fpt or ghec %}
38-
* Mutual connections, including people both you and the viewer follow
39-
{%- endif %}
40-
* Your status message sharing information about your availability (if you have set one)
27+
Your profile includes these customizable elements:
28+
29+
* **Profile README**: A customizable section at the top of your profile
30+
* **Personal info**: Profile picture, name,{% ifversion profile-pronouns %} pronouns,{% endif %} and bio
31+
* **Contribution activity**: Visualizes your work on {% data variables.product.github %}
32+
* **Pinned items**: Repositories and gists you choose to highlight
33+
* **Status**: Shows your current availability and what you're working on
34+
* **Achievements and badges**: Recognizes your participation in programs or milestones
35+
36+
## Your profile README
37+
38+
You can share information about yourself with the community on {% data variables.product.prodname_dotcom %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.
39+
40+
You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.
41+
42+
* An "About me" section that describes your work and interests
43+
* Contributions you're proud of, and context about those contributions
44+
* Guidance for getting help in communities where you're involved
45+
46+
You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github).
47+
48+
{% ifversion fpt %}
49+
50+
## Private profiles
51+
52+
To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.github %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity.
53+
54+
After making your profile private, you can still view all your information when you visit your own profile.
55+
56+
For more information, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private).
57+
58+
### Differences between private and public profiles
59+
60+
When your profile is private, the following content is hidden from your profile page:
61+
62+
* Achievements and highlights
63+
* Activity overview and activity feed
64+
* Contribution graph
65+
* Follower and following counts
66+
* Follow and Sponsor buttons
67+
* Organization memberships
68+
* Stars, projects, packages, and sponsoring tabs
69+
* Your pronouns
70+
71+
When your profile is private, the following optional fields are still **publicly** visible:
72+
73+
* README
74+
* Bio
75+
* Profile picture
76+
77+
When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations:
78+
79+
* Activity feeds for other users
80+
* Discussions leaderboards
81+
* Site-wide search results
82+
* The [Trending](https://github.com/trending) page
83+
84+
## Profile visibility options
85+
86+
You can control the visibility of specific profile elements or set your entire profile to private.
87+
88+
{% endif %}
4189

4290
## Next steps
4391

44-
To start customizing your profile, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile) and [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
92+
* For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile).
93+
* For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile).
94+
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).

content/account-and-profile/get-started/profile.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,10 @@ topics:
1010
shortTitle: Profile
1111
---
1212

13-
## About profiles
13+
## About your {% data variables.product.github %} profile
1414

15-
Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.
15+
Your profile is how other people discover and learn about you on {% data variables.product.github %}. You can customize your profile to highlight your best work and share more about yourself.
1616

17-
{% ifversion fpt or ghec %}
18-
19-
> [!IMPORTANT]
20-
> Any details you add to your public profile will be visible to all {% data variables.product.github %} users, including in regions where local laws, regulations, or cultural norms may pose risks to expressing your identity. We respect everyone’s decision about whether or not to share information about themselves on their {% data variables.product.github %} profile.
21-
22-
{% endif %}
23-
24-
## Key profile elements
25-
26-
Your profile includes these customizable elements:
27-
28-
* **Personal info**: Profile picture, name, bio, and pronouns
29-
* **Status**: Shows your current availability and what you're working on
30-
* **Pinned items**: Repositories and gists you choose to highlight
31-
* **Contribution activity**: Visualizes your work on {% data variables.product.github %}
32-
* **Profile README**: A customizable section at the top of your profile
33-
* **Achievements and badges**: Recognizes your participation in programs or milestones
34-
35-
## Profile visibility
36-
37-
You can control the visibility of specific profile elements or set your entire profile to private.
38-
39-
## Next steps
40-
41-
* For more details about your profile, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile).
4217
* For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile).
4318
* For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile).
4419
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).

content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,6 @@ redirect_from:
1414
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme
1515
shortTitle: Your profile README
1616
---
17-
## About your profile README
18-
19-
You can share information about yourself with the community on {% data variables.product.prodname_dotcom %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.
20-
21-
You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.
22-
23-
* An "About me" section that describes your work and interests
24-
* Contributions you're proud of, and context about those contributions
25-
* Guidance for getting help in communities where you're involved
26-
27-
![Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.](/assets/images/help/repository/profile-with-readme.png)
28-
29-
You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github). For a hands-on guide to customizing your profile README, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github).
3017

3118
## Prerequisites
3219

@@ -59,10 +46,6 @@ The profile README will be removed from your {% data variables.product.prodname_
5946

6047
The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility#changing-a-repositorys-visibility).
6148

62-
## Further reading
49+
## Next steps
6350

64-
* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
65-
* [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-member-only-organization-profile-readme)
66-
{%- ifversion enterprise-readme %}
67-
* [AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise)
68-
{%- endif %}
51+
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference).

content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,19 @@ topics:
1515
- Profiles
1616
shortTitle: Pin items
1717
---
18-
You can pin a public repository if you own the repository or you've made contributions to the repository within the last year. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)
1918

20-
You can pin any public gist you own.
21-
22-
Pinned items include important information about the item, like the number of stars a repository has received or the first few lines of a gist. Once you pin items to your profile, the "Pinned" section replaces the "Popular repositories" section on your profile.
23-
24-
You can reorder the items in the "Pinned" section. In the upper-right corner of a pin, click {% octicon "grabber" aria-label="The grabber symbol" %} and drag the pin to a new location.
19+
## Pinning items to your profile
2520

2621
{% data reusables.profile.access_profile %}
2722
1. At the top of the "Popular repositories" or "Pinned" section, click **Customize your pins**.
2823

2924
![Screenshot of the "Pinned" section of a user profile. A link, labeled "Customize your pins", is highlighted with an orange outline.](/assets/images/help/profile/customize-pinned-repositories.png)
3025
1. Optionally, to change which items are included in the searchable list, next to "Show", select or deselect **Repositories** and **Gists**.
3126
1. Optionally, to make it easier to find a specific item, in the "Filter repositories and gists" field, type the name of a user, organization, repository, or gist.
27+
1. Optionally, reorder the items in the "Pinned" section. In the upper-right corner of a pin, click {% octicon "grabber" aria-label="The grabber symbol" %} and drag the pin to a new location.
3228
1. Select up to six repositories and gists, combined.
3329
1. Click **Save pins**.
3430

3531
## Further reading
3632

37-
* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)
33+
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#pinning-items-to-your-profile).

content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md

Lines changed: 5 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,15 @@ shortTitle: Set profile to private
99
redirect_from:
1010
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private
1111
---
12-
## About private profiles
13-
14-
To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.prodname_dotcom %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity.
15-
16-
After making your profile private, you can still view all your information when you visit your own profile.
17-
18-
Private profiles cannot receive sponsorships under [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). To be eligible for {% data variables.product.prodname_sponsors %}, your profile cannot be private.
19-
20-
## Differences between private and public profiles
21-
22-
When your profile is private, the following content is hidden from your profile page:
23-
24-
* Achievements and highlights
25-
* Activity overview and activity feed
26-
* Contribution graph
27-
* Follower and following counts
28-
* Follow and Sponsor buttons
29-
* Organization memberships
30-
* Stars, projects, packages, and sponsoring tabs
31-
* Your pronouns
32-
33-
> [!NOTE]
34-
> When your profile is private, some optional fields are still publicly visible, such as the README, biography, and profile picture.
35-
36-
## Changes to reporting on your activities
37-
38-
By making your profile private, you will not remove or hide past activity; this setting only applies to your activity while the private setting is enabled.
39-
40-
When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations:
41-
42-
* Activity feeds for other users
43-
* Discussions leaderboards
44-
* Site-wide search results
45-
* The [Trending](https://github.com/trending) page
46-
47-
> [!NOTE]
48-
> Your activity on public repositories will still be publicly visible to anyone viewing those repositories, and some activity data may still be available through the {% data variables.product.prodname_dotcom %} API.
4912

5013
## Changing your profile's privacy settings
5114

5215
{% data reusables.user-settings.access_settings %}
5316
1. Navigate to the "Public profile" section, and scroll down to "Contributions & Activity"
5417
1. Select the checkbox next to **Make profile private and hide activity**.
5518
{% data reusables.user-settings.update-preferences %}
19+
20+
## Next steps
21+
22+
* For more information about private profiles, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile#private-profiles).
23+
* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#limitations-of-private-profiles).

0 commit comments

Comments
 (0)