Skip to content

Conversation

@kumar-kalyan
Copy link

@kumar-kalyan kumar-kalyan commented Dec 25, 2021

Added some image slides showing how to create organization's profile

Why:

Closes #13376

What's being changed:

Check off the following:

  • [ x ] I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • [ x ] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

Added some image slides showing how to create organization's profile
@welcome
Copy link

welcome bot commented Dec 25, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions
Copy link
Contributor

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Staging Production What Changed
content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md Modified Original

@github-actions github-actions bot temporarily deployed to docs-13377--patch-2 December 25, 2021 21:28 Inactive
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review labels Dec 27, 2021
@ramyaparimi
Copy link
Contributor

@kum9748ar
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Member

@lecoursen lecoursen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kum9748ar! After you incorporate my feedback, we'll review this PR again.

Comment on lines +27 to +41
![image](https://user-images.githubusercontent.com/67071462/147393148-73c474f4-cb8c-4d8c-b492-3127885f6bc4.png)

2. Optionally, add a description of your organization's repository. For example, "My organization's repository."

![image](https://user-images.githubusercontent.com/67071462/147393226-85bda11c-7cf9-42c8-931e-990e4f924c83.png)

3. Select **Public**

![image](https://user-images.githubusercontent.com/67071462/147393297-e0c23bf1-02fe-495e-a46d-25a59659578b.png)

4. Select any one form **Initialize this repository**.

![image](https://user-images.githubusercontent.com/67071462/147393347-326a3b79-c938-4c76-857f-4638cf08c165.png)

5. Click **Create repository.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Steps 2-5 are all part of creating a .github repository, which is step 1. Instead of adding these steps, let's add a link to the existing procedure at the end of the existing step 1:

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#creating-a-repository-for-default-files


![image](https://user-images.githubusercontent.com/67071462/147393503-adcd90b2-a923-400f-844d-ec364e7d388d.png)

7. The generated README file is pre-populated with a template to give you some inspiration for your organization's profile README.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each procedural step needs to be an imperative (command). We can add context like this after the imperative.

Suggested change
7. The generated README file is pre-populated with a template to give you some inspiration for your organization's profile README.
7. Edit the generated README file, which is pre-populated with a template to give you some inspiration for your organization's profile README.


![image](https://user-images.githubusercontent.com/67071462/147393542-a2289ebb-df6e-425d-8b37-f1bf058a4e21.png)

For a summary of all the available emojis and their codes, see "[Emoji cheat sheet](http://www.emoji-cheat-sheet.com/)."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this line. It might be interesting to some folks, but it makes the procedure longer and therefore increases the cognitive load of reading the article, without being useful enough to justify that. We should only document what users need to know to be successful in their task.

@ramyaparimi
Copy link
Contributor

@kum9748ar Checking in to see if you are still able to work on this PR 💖.

Thanks so much for your time in contributing to the GitHub docs ✨ .

@ramyaparimi ramyaparimi removed the waiting for review Issue/PR is waiting for a writer's review label Feb 28, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2022

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Mar 7, 2022
@github-actions github-actions bot closed this Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team stale There is no recent activity on this issue or pull request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update steps described in Adding an organization profile README

3 participants