diff --git a/content/account-and-profile/concepts/about-your-profile.md b/content/account-and-profile/concepts/about-your-profile.md index 14305a04956b..006059338bd0 100644 --- a/content/account-and-profile/concepts/about-your-profile.md +++ b/content/account-and-profile/concepts/about-your-profile.md @@ -1,7 +1,7 @@ --- title: About your profile shortTitle: Personal profile -intro: 'Your profile page tells people your story through the information you share, the contributions you make, and the projects you showcase.' +intro: 'Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly.' redirect_from: - /articles/viewing-your-feeds - /articles/profile-pages @@ -16,29 +16,79 @@ versions: topics: - Profiles --- -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. -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. -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. +Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly. -![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) +{% data reusables.profile.profile-visibility %} -People who visit your profile can also see: +## Key profile elements -* A timeline of your contribution activity, like issues and pull requests you've opened, commits you've made, and pull requests you've reviewed -* Repositories and gists you own or contribute to. You can showcase your best work by pinning repositories and gists to your profile. -* Repositories you've starred{% ifversion fpt or ghec %} and organized into lists{% endif %} -* An overview of your activity in organizations, repositories, and teams you're most active in{% ifversion fpt or ghec %} -* 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 %} -{%- ifversion profile-pronouns %} -* Your pronouns (if you have set them) -{%- endif %} -{%- ifversion fpt or ghec %} -* Mutual connections, including people both you and the viewer follow -{%- endif %} -* Your status message sharing information about your availability (if you have set one) +Your profile includes these customizable elements: + +* **Profile README**: A customizable section at the top of your profile +* **Personal info**: Profile picture, name,{% ifversion profile-pronouns %} pronouns,{% endif %} and bio +* **Contribution activity**: Visualizes your work on {% data variables.product.github %} +* **Pinned items**: Repositories and gists you choose to highlight +* **Status**: Shows your current availability and what you're working on +* **Achievements and badges**: Recognizes your participation in programs or milestones + +## Your profile README + +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. + +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. + +* An "About me" section that describes your work and interests +* Contributions you're proud of, and context about those contributions +* Guidance for getting help in communities where you're involved + +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). + +{% ifversion fpt %} + +## Private profiles + +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. + +After making your profile private, you can still view all your information when you visit your own profile. + +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). + +### Differences between private and public profiles + +When your profile is private, the following content is hidden from your profile page: + +* Achievements and highlights +* Activity overview and activity feed +* Contribution graph +* Follower and following counts +* Follow and Sponsor buttons +* Organization memberships +* Stars, projects, packages, and sponsoring tabs +* Your pronouns + +When your profile is private, the following optional fields are still **publicly** visible: + +* README +* Bio +* Profile picture + +When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations: + +* Activity feeds for other users +* Discussions leaderboards +* Site-wide search results +* The [Trending](https://github.com/trending) page + +## Profile visibility options + +You can control the visibility of specific profile elements or set your entire profile to private. + +{% endif %} ## Next steps -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). +* For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile). +* For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile). +* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference). diff --git a/content/account-and-profile/get-started/profile.md b/content/account-and-profile/get-started/profile.md index ea82965c85d6..e659dcca837a 100644 --- a/content/account-and-profile/get-started/profile.md +++ b/content/account-and-profile/get-started/profile.md @@ -10,35 +10,10 @@ topics: shortTitle: Profile --- -## About profiles +## About your {% data variables.product.github %} profile -Your {% data variables.product.github %} profile showcases your work, contributions, and information you choose to share publicly. +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. -{% ifversion fpt or ghec %} - -> [!IMPORTANT] -> 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. - -{% endif %} - -## Key profile elements - -Your profile includes these customizable elements: - -* **Personal info**: Profile picture, name, bio, and pronouns -* **Status**: Shows your current availability and what you're working on -* **Pinned items**: Repositories and gists you choose to highlight -* **Contribution activity**: Visualizes your work on {% data variables.product.github %} -* **Profile README**: A customizable section at the top of your profile -* **Achievements and badges**: Recognizes your participation in programs or milestones - -## Profile visibility - -You can control the visibility of specific profile elements or set your entire profile to private. - -## Next steps - -* For more details about your profile, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile). * For a general tutorial on personalizing your profile, see [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile). * For more specific profile customization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-github-profile). * For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index 10063002c1ca..07678eae5258 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -14,19 +14,6 @@ redirect_from: - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme shortTitle: Your profile README --- -## About your profile README - -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. - -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. - -* An "About me" section that describes your work and interests -* Contributions you're proud of, and context about those contributions -* Guidance for getting help in communities where you're involved - -![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) - -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). ## Prerequisites @@ -59,10 +46,6 @@ The profile README will be removed from your {% data variables.product.prodname_ 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). -## Further reading +## Next steps -* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) -* [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile#adding-a-member-only-organization-profile-readme) -{%- ifversion enterprise-readme %} -* [AUTOTITLE](/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise) -{%- endif %} +* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md index afa346192ea4..d1e744280fdf 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md @@ -15,13 +15,8 @@ topics: - Profiles shortTitle: Pin items --- -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) -You can pin any public gist you own. - -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. - -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. +## Pinning items to your profile {% data reusables.profile.access_profile %} 1. At the top of the "Popular repositories" or "Pinned" section, click **Customize your pins**. @@ -29,9 +24,10 @@ You can reorder the items in the "Pinned" section. In the upper-right corner of ![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) 1. Optionally, to change which items are included in the searchable list, next to "Show", select or deselect **Repositories** and **Gists**. 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. +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. 1. Select up to six repositories and gists, combined. 1. Click **Save pins**. ## Further reading -* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile) +* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#pinning-items-to-your-profile). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md index f16ba8f0a619..e13783c7738f 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md @@ -9,43 +9,6 @@ shortTitle: Set profile to private redirect_from: - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private --- -## About private profiles - -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. - -After making your profile private, you can still view all your information when you visit your own profile. - -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. - -## Differences between private and public profiles - -When your profile is private, the following content is hidden from your profile page: - -* Achievements and highlights -* Activity overview and activity feed -* Contribution graph -* Follower and following counts -* Follow and Sponsor buttons -* Organization memberships -* Stars, projects, packages, and sponsoring tabs -* Your pronouns - -> [!NOTE] -> When your profile is private, some optional fields are still publicly visible, such as the README, biography, and profile picture. - -## Changes to reporting on your activities - -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. - -When your profile is private, your {% data variables.product.prodname_dotcom %} activity will not appear in the following locations: - -* Activity feeds for other users -* Discussions leaderboards -* Site-wide search results -* The [Trending](https://github.com/trending) page - -> [!NOTE] -> 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. ## Changing your profile's privacy settings @@ -53,3 +16,8 @@ When your profile is private, your {% data variables.product.prodname_dotcom %} 1. Navigate to the "Public profile" section, and scroll down to "Contributions & Activity" 1. Select the checkbox next to **Make profile private and hide activity**. {% data reusables.user-settings.update-preferences %} + +## Next steps + +* For more information about private profiles, see [AUTOTITLE](/account-and-profile/concepts/about-your-profile#private-profiles). +* For reference information, see [AUTOTITLE](/account-and-profile/reference/profile-reference#limitations-of-private-profiles). diff --git a/content/account-and-profile/reference/profile-reference.md b/content/account-and-profile/reference/profile-reference.md index 6bb4e42afcff..0fe1c47a3a61 100644 --- a/content/account-and-profile/reference/profile-reference.md +++ b/content/account-and-profile/reference/profile-reference.md @@ -12,11 +12,7 @@ shortTitle: Profile reference ## Visibility of profile information -{% ifversion fpt or ghec %} - -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. - -{% endif %} +{% data reusables.profile.profile-visibility %} The name that is displayed on your profile may also be displayed next to comments you make on private repositories owned by an organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization). @@ -28,6 +24,16 @@ The name that is displayed on your profile may also be displayed next to comment Links to your social accounts are visible to anyone who can view your profile. +## Profile picture requirements + +When you sign up for an account, {% data variables.product.github %} provides you with a randomly generated "identicon". [Your identicon](https://github.com/blog/1586-identicons) generates from a hash of your user ID, so there's no way to control its color or pattern. You can replace your identicon with an image that represents you. + +> [!NOTE] {% ifversion ghec %} +> * {% endif %}Your profile picture should be a PNG, JPG, or GIF file, and it must be less than 1 MB in size and smaller than 3000 by 3000 pixels. For the best quality rendering, we recommend keeping the image at about 500 by 500 pixels. +{% ifversion ghec %}> * Gravatar profile pictures are not supported with {% data variables.product.prodname_emus %}.{% endif %} + +If you use Gravatar, and your Gravatar image is associated with the email you use for {% data variables.product.github %}, the image will be shown as your {% data variables.product.github %} profile picture by default (rather than an identicon). To change your profile picture, you can either upload a new image to Gravatar, or upload a new image to {% data variables.product.github %} and override the Gravatar image. + ## Profile status Your status will show: @@ -43,16 +49,6 @@ If you select the "Busy" option, when people @mention your username, assign you ![Screenshot of a draft comment. "@octocat" is written in the text field, and "The Octocat (busy)" is suggested.](/assets/images/help/profile/username-with-limited-availability-text.png) -## Profile picture requirements - -When you sign up for an account, {% data variables.product.github %} provides you with a randomly generated "identicon". [Your identicon](https://github.com/blog/1586-identicons) generates from a hash of your user ID, so there's no way to control its color or pattern. You can replace your identicon with an image that represents you. - -> [!NOTE] {% ifversion ghec %} -> * {% endif %}Your profile picture should be a PNG, JPG, or GIF file, and it must be less than 1 MB in size and smaller than 3000 by 3000 pixels. For the best quality rendering, we recommend keeping the image at about 500 by 500 pixels. -{% ifversion ghec %}> * Gravatar profile pictures are not supported with {% data variables.product.prodname_emus %}.{% endif %} - -If you use Gravatar, and your Gravatar image is associated with the email you use for {% data variables.product.github %}, the image will be shown as your {% data variables.product.github %} profile picture by default (rather than an identicon). To change your profile picture, you can either upload a new image to Gravatar, or upload a new image to {% data variables.product.github %} and override the Gravatar image. - ## Profile location and time zone You can set a location and time zone on your profile to show other people your local time. Your location and time zone will be visible: @@ -63,6 +59,26 @@ You can set a location and time zone on your profile to show other people your l When you view your profile, you will see your location, local time, and your time zone in relation to Universal Time Coordinated. When others view your profile, they will see your location, local time, and the time difference in hours from their own local time. +## Pinning items to your profile + +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) + +You can pin any public gist you own. + +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. + +{% ifversion fpt %} + +## Limitations of private profiles + +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. + +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. + +When your profile is private, 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. + +{% endif %} + {% ifversion fpt or ghec %} ## Displaying badges on your profile @@ -96,6 +112,8 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %} {% endif %} +If you `@mention` an organization you're a member of in your bio, that organization will be featured first in your activity overview. + ## List of qualifying repositories for Mars 2020 Helicopter Contributor achievement The Mars 2020 Helicopter Contributor achievement was given to those who had authored a commit for one of the repositories listed below. This event has now ended, and the badge is no longer available. We built the list based on information received from NASA's Jet Propulsion Laboratory. @@ -170,7 +188,3 @@ The Mars 2020 Helicopter Contributor achievement was given to those who had auth | [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) | | [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) | | [apache/logging-log4j2](https://github.com/apache/logging-log4j2) | 2.11 | [log4j-2.11.0](https://github.com/apache/logging-log4j2/releases/tag/log4j-2.11.0) | - -## Further reading - -* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile) diff --git a/data/reusables/profile/profile-visibility.md b/data/reusables/profile/profile-visibility.md new file mode 100644 index 000000000000..6d8a34f7898d --- /dev/null +++ b/data/reusables/profile/profile-visibility.md @@ -0,0 +1,6 @@ +{% ifversion fpt or ghec %} + +> [!IMPORTANT] +> 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. + +{% endif %}