How to add your PowerShell blog to Planet PowerShell

Do you blog about PowerShell? If so, consider adding your blog site to Planet PowerShell which is an aggregator of content from PowerShell Community members. There are some guidelines for submission on their GitHub page so be sure to take a look at it before continuing. Instructions for adding your blog also exists on that page, but I’ve recently seen a number of tweets about it being too difficult or too much work. To be honest with you, if everything in IT was as easy as adding my blog to Planet PowerShell, I probably wouldn’t have a job. I decided to try to make the process a little easier, regardless (I’m not affiliated with Planet PowerShell other than having added my blog to it).

First, you need to fork the Planet PowerShell repository on GitHub:

Forking a repository creates your own personal copy of it underneath your GitHub account as denoted by #1 in the following image:

Go to your copy of the Planet PowerShell repository on GitHub. Click on the “Clone or download” button (#2) and then click on the “Copy to clipboard” button (#3).

Clone your copy of the repository to your computer. Be sure to change the source path to match your copy of the Planet PowerShell repository (use the path that you copied to your clipboard in the previous step). Change the destination path if needed. I’ll store the destination path in a variable named $LocalPath since I’ll be using it again later in this blog article.

If you don’t already have Git installed (which is used in the previous example) or if you’re not familiar with Git, you can find more information about it in my blog article titled “Getting Started with the Git Version Control System“.

I’ll store my first and last name in variables since they’ll be used throughout this blog article. Your name should be in proper case.

I wrote a PowerShell function to create your author file for Planet PowerShell. This function is part of my MrToolkit module which can be found in my PowerShell repository on GitHub. It uses some of the other functions found in that module as well as my MrGeo module which can be found in my ScriptingGames repository on GitHub.

Simply run the function and provide your information via parameter input.

The output can be used to create the necessary .cs file:

Verify that the contents of the .cs file looks correct:

Add the class to the .csproj file:

Verify the class has been added:

I can see that one file has been added and one file has been modified in my local copy of my Planet PowerShell repo:

Do you like how my PowerShell prompt changes automatically when I’m in a directory that’s part of a Git repository? If so, be sure to see my blog article on “Configuring the PowerShell ISE for use with Git and GitHub“.

Add any new or modified files, commit them to the local copy of the repository, and push the changes to your copy of the repository on GitHub:

Submit a pull request:

Click the “Create pull request button”:

The pull request has to be reviewed and approved by the owners of Planet PowerShell. Once that occurs, it may take a few days for your blog articles to start showing up in their RSS feed.


Update 3/30/2017 – I’ve added the one function in the MrGeo module to the MrToolkit module so only one module is required. I’ve also updated my MrToolkit module on the PowerShell Gallery so you can simply run Install-Module -Name MrToolkit -Force to install the module on a computer with PowerShell version 5.0 or higher or one that has installed the package management MSI for down-level versions.

µ

2 Comments

  1. SignalWarrant

    Mike,

    Thanks for this write-up, well done.

    Reply
  2. Vladimir Bundalo

    Hi Mike. Thanks for the suggestion. I do have a blog site where I write about PowerShell mainly, but don’t think it is ready yet to be added. So I will write a bit more and then apply. Thanks for a very good guide.

    Reply

Leave a Reply

%d bloggers like this: