You can write about anything that generally intersects with CC and technology. Some examples:
It is a good idea to float what you're going to write about with the CC tech team ahead of time so that we can give you feedback before you put in the work of writing it.
Structuring posts about your project
If you're writing about a project you're working on, here are a few ways you could structure your post:
If you have more tips, submit an edit to this page.
Once you have written your post, you can either send it to us (Markdown is easiest for us, but we're happy to work with other formats) or directly create a pull request for your post as detailed below.
Pull requests should be submitted to the creativecommons.github.io-source repository. The CC Open Source site is built using the static site generator Lektor and your blog post must follow the specific format documented below to appear correctly on the site. For example, please see this commit adding a post.
contents.lrin the subdirectory you just created. This is the file that will contain your blog post content.
contents.lr in the following format (see example post):
title: Replace this text with the title of your blog post --- categories: Replace this text with category names as shown below. Each category name should be on its own line and the name should not contain spaces. example-category-name-1 example-category-name-2 --- author: Replace this text with author's GitHub username. There should be no spaces in the name. --- pub_date: Replace this text with the publication date in YYYY-MM-DD format. --- body: Replace this text with your post's content (minus the title). This field accepts Markdown for formatting. If you're including images, you can use the Markdown image syntax i.e. ![image-title](image-file-name.jpg). You don't need to specify the path to the image since you have uploaded it to the same folder in Step 3.
Read more about Markdown formatting here.
contents.lrfile within should follow the same format as the other categories. Here's an example category content file.
usernamefield in the
contents.lrfile should also use the same exact username.
contents.lrfile within should follow the same format as the other authors. Here's an example author content file.
contents.lrfile within should follow the same format as the other series. Here's an example series content file.
creativecommons.github.io-sourceproject locally (instructions are in the
READMEin the repository) and ensure your blog post shows up correctly locally. If you have not created the appropriate category or author files, you will see a build error in this step.
Once merged, your new post will automatically be pushed to the production site and a notification containing your post URL will be sent to the
#cc-developers channel on Slack.