From 17fcd4fb1df6b7f4e42d8c285ef9df08ec5e8205 Mon Sep 17 00:00:00 2001 From: Daniel Adams Date: Tue, 14 Sep 2021 15:09:09 +0200 Subject: [PATCH] [Sept 14] Add customize organization page (#21233) * 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 <56270045+ethanpalm@users.noreply.github.com> * Update content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * fix failing test * Update content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Update variable Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- .../about-your-organizations-profile.md | 2 +- .../customizing-your-organizations-profile.md | 28 +++++++++++++++++++ .../index.md | 1 + 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 4a429f1b62..85dd3fd5d8 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -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 %} diff --git a/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md new file mode 100644 index 0000000000..c4b076b715 --- /dev/null +++ b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md @@ -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. diff --git a/content/organizations/collaborating-with-groups-in-organizations/index.md b/content/organizations/collaborating-with-groups-in-organizations/index.md index 882508953f..eaa8386282 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/index.md +++ b/content/organizations/collaborating-with-groups-in-organizations/index.md @@ -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