Set up a GitHub Profile README for an Organization
In this video, we tackle the organization profile README for Stateless Code. We start by assuming (incorrectly) that the structure of an organization profile README is the same as a personal profile README and create a repository with the same name as our org. We create a README for that repository using GitHub's Markdown editor and...
...nothing.
In order for a profile README to show up in an org, you need to have a .github repo for the org (instead of one matching the org name) AND the profile README needs to be located at the path profile/README.md instead of the root README for the .github repo.
We clone the repo onto our machine and add some links to assets. In doing so, we learn that organization profile links can't be relative. We wind up using that statelesscode repo we created at first as the location for the Stateless Code assets, branding, and icons.
Eventually we work out the kinks and get a working README profile associated with our org.
This video covers:
00:00:00 Retrospective introduction after recording the video and noting the pitfalls
00:01:27 Original introduction and example of a GitHub profile README from Atharva Salitri
00:02:43 Create a repo matching the organization name (not the right choice for an organization profile, but we'll still make use of it)
00:04:46 Edit the README on GitHub (and use a draft issue for better markdown editor features)
00:05:59 Review the first draft of the README
00:08:14 Double check links and fix broken or erroneous links
00:13:19 Commit initial changes to the statelesscode.git README, review and discover that organizations need a .github repo
00:15:14 Create a .github.git respository for the organization
00:16:18 Clone both the statelesscode.git and .github.git repos using the command line.
00:18:08 Copy the profile README from the statelesscode repo to the .github repo
00:19:28 Get the Stateless Code branding and assets into the .github repo and replace the placeholder text for Website with a reference to the stateless code logo
00:23:36 Add an image to the top of the README and do a commit on the .github repo
00:25:06 Take a look at GitHub. Not working. The profile README is not in the correct location and the find and replace for the links was not done correctly
00:26:38 Fix malformed markup in README (find and replace error) and force push (twice)
00:30:00 Move the README to the profile directory of the .github repo and change relative links to assets and force push again
00:32:53 Profile README showing up on org profile but relative asset links not working. They need to be absolute links for an org profile
00:34:50 Move the assets to the statelesscode.git repo and push them
00:39:04 Refer to the abosolute links of the assets in the .github repo and remove the assets from the .github repo. Force push again
00:43:27 Validate that everything is working as expected. Reference to assets folder now broken. Fix that and force push one last time
#github #githubprofile #githuborg #orgprofile #readme #orgreadme
See other related StatelessCode videos:
Create a RubyGem 101: Retro on Version 0.5.0 and Patch Releases • Create a RubyGem 101: Retro on Versio...
Create a RubyGem 92: Add Contributing Guidelines to the Project • Create a RubyGem 92: Add Contributing...
Resources that we relied upon for this solution:
Atharva Salitri's GitHub profile https://github.com/the-amazing-atharva
Dan Cranney ProfileMe.dev (used for social icons) https://github.com/danielcranney/prof...
This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.
Watch video Set up a GitHub Profile README for an Organization online without registration, duration hours minute second in high quality. This video was added by user Stateless Code 08 May 2023, don't forget to share it with your friends and acquaintances, it has been viewed on our site 494 once and liked it 7 people.