Skip to content

Commit

Permalink
[Sept 14] Add customize organization page (github#21233)
Browse files Browse the repository at this point in the history
* Add customize organization page

* Add forward for personalizing org profile

* Update content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md

Co-authored-by: Ethan Palm <[email protected]>

* Update content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

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

Co-authored-by: Ethan Palm <[email protected]>

* fix failing test

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

Co-authored-by: Ethan Palm <[email protected]>

* Update variable

Co-authored-by: Ethan Palm <[email protected]>
  • Loading branch information
dipree and ethanpalm authored Sep 14, 2021
1 parent 33aaf8e commit 17fcd4f
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topics:
- Profiles
shortTitle: Organization's profile
---
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories to the top of the page.
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories. 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)."

{% ifversion fpt %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your 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)."{% endif %}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Customizing your organization's profile
intro: You can share information about your organization by customizing your organization's profile
versions:
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Organizations
shortTitle: Customize organization profile
---

## About your organization's profile README

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.

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.

- 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

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.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ children:
- /about-your-organization-dashboard
- /creating-a-new-organization-from-scratch
- /accessing-your-organizations-settings
- /customizing-your-organizations-profile
- /about-your-organizations-news-feed
- /viewing-insights-for-your-organization
shortTitle: Collaborate with groups
Expand Down

0 comments on commit 17fcd4f

Please sign in to comment.