Add your feed to Planet Ubuntu

If you’d like your blog to be aggregated on Planet Ubuntu, you need only follow a few steps!

Prerequisites

• Be an official Ubuntu Member
• A GitHub Account.
• The exact URL of your RSS, Atom, or .xml/.rss feed (e.g., https://your-awesome-blog.com/feed.xml).

Step 1: Fork the Repository

First, you need to create your own editable copy of the Ubuntu Planet project.

1. Go to the main repository page: https://github.com/Ubuntu-Community-Team/terra

2. In the top-right corner, click the "Fork" button.

3. Choose a name for your fork and click "Create fork." This creates a copy of the entire project under your GitHub account (your-username/terra).

Step 2: Edit the feeds.json file

Now, you can edit the feeds list and add your own:

1. In your newly created fork (your-username/terra), navigate to the file: feeds.json (The full path is /terra/feeds.json).

2. Click the pencil icon (✏️) in the top right of the file view to start editing.

3. Add your feed entry to the bottom of the list, just before the closing square bracket (]).

Example of adding a new Planet entry

Ensure your new entry follows this structure exactly, separating the name and url with a comma, and ending your entry with a comma unless it's the very last one.

[
// ... (Existing entries above)
{
  "name": "My Awesome Ubuntu Blog",
  "nick": "my-launchpad-id",
  "url": "https://my-awesome-blog.com/feed.xml"
},
{
  "name": "Other Cool Ubuntu Blog",
  "nick": "wartywarthog",
  "url": "https://ubuntu.com/blog/feed/"
}
// <-- NOTE: No comma after the very last entry
]

        

Step 3: Commit the Changes

After adding your feed to the list, you need to save your changes to your fork.

1. Scroll down to the "Commit changes" section at the bottom of the page.

2. Enter a clear commit message like: Add: My Blog Name to feeds.json

3. Ensure the "Commit directly to the main branch" radio button is selected.

4. Click the green "Commit changes" button.

Step 4: Create a Pull Request (PR)

The final step is to submit your change from your fork back to the main repository.

1. Go back to the main page of your fork (your-username/terra).

2. You should see a highlighted box indicating that your main branch is ahead of the original. Click the green "Contribute" button, and then click "Open pull request."

3. Review the changes (it should only show your added lines in feeds.json).

4. Add a brief title and description explaining who you are and why you're adding your feed (e.g., "Adding feed for Ubuntu Member John Doe").

5. Click the green "Create pull request" button.

Once your Pull Request is created, it will be reviewed, merged and the automated Planet aggregator will pick it up on the next refresh.