Planet Elm guidelines

Itamar Shapira Bar-Lev edited this page Nov 27, 2015 · 4 revisions
Clone this wiki locally

Planet Elm is an aggregated list of feeds about Elm from around the web. It provides a place for interesting content from around the community that may not fit the existing topical sections of Elm.org, Groups.Elm.org, and other official forums. Its purpose is the sharing of useful and relevant Elm-related knowledge; posts that are aggregated on the planet should help others learn details about Elm that they might not otherwise encounter. Content on Planet Elm is discarded after 16 weeks.

Content that's great for Planet Elm:

  • How-tos, guides, and tutorials that highlight how to use Elm effectively.
  • Case studies that highlight how Elm was used on a project.
  • Slides and presentations from Elm-related talks, or notes from a past presentation.
  • Community news, like progress updates on an in-progress Elm initiative or project.
  • Posts should be in English since that's the language used on elm-lang.org.

Content that doesn't fit Planet Elm:

  • Press releases. These can be posted into the News and Announcements forum.
  • Job announcements and hiring announcements. It's fine to mention a career change in the context of another post, but remember that Elm Planet isn't LinkedIn. Job postings can be posted into the Jobs page.
  • General web development and programming posts that only mention Elm in passing.
  • "I Love Elm!" posts that don’t provide valuable, actionable content to readers.

If you have content fitting the requirements above, then here are the next steps.

  1. You must have an RSS feed that contains only content appropriate for Elm Planet.
  2. Your feed must have at least two posts already so we can evaluate the content and make sure it is appropriate for the Planet.
  3. Your feed must pass source code validation, since the aggregator we are using is very strict about parsing feed source code.
  4. It is recommended that you trim, or use a summary for your feed content between 600 and 1000 characters. Due to the number of posts on the Planet, this will make it more pleasant for readers to find what is interesting for them without having to scroll page after page.
  5. It is recommended that you enable reader comments for content that appears on Elm Planet. Because Planet content is intended to increase communication and connection in the Elm community, dialogue and feedback are important.
  6. It is strongly recommended that you avoid relative URLs to images in your posts. They won't display for people reading your post on planet.elm-lang.org (this problem is mitigated if you provide a teasered feed) and is generally discouraged.
  7. Once your feed meets the above requirements, create an issue in the planet-elm repository asking to be added to the Planet. Remember to include the link to your feed, as well as the name you would like in the listing (e.g. Jane Doe or My Company Name). A feed may be removed from the Planet if:
  • it does not meet the content guidelines stated above
  • it contains spam, is hacked or posts are offensive
  • it no longer works or no longer Elm specific
  • it hasn't been updated in a year

If you find a post on Planet Elm that you feel is inappropriate or in violation of the content requirements above, create an issue for it in the planet-elm repository. Please do not leave comments on the article itself telling the author that his/her post is not welcome on Planet Elm: the Elm Planet moderators will look into the issue and determine whether the violation merits a warning or removal from the Planet feed.

Feed owners who disagree with a decision can appeal by creating a followup issue in the Elm.org Content project. The appeal will be discussed and voted on by the Elm Planet content moderators, but their decision will be final.

Important issue for blogs hosted on GitHub with custom domain

You will need to follow the steps and make sure you remove the ALIAS and use CNAME instead.

Example for creating custom RSS feed for Elm tags on Jekyll

An example can be found here

-- Copied and adapted from Planet Drupal guidelines