Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

Blogging in Codewind

Jump to bottom
S. Ishida edited this page May 14, 2020 · 8 revisions

Where are all the blog posts?

  • The blog posts are in the _blog folder in the codewind-docs repository.
  • The posts use the format YYYY-MM-DD-.md. The date is used for ordering the posts.
  • Use the eGA date for the Codewind release as your post date
  • For your post name, this name will show up as the URL. Use something descriptive. The post date is not used to form the URL (only the post name), so ensure you don't name your post name the same as an existing blog post. That is, 2019-08-21-codewind-is-awesome.md will conflict with 2020-04-01-codewind-is-awesome.md

Where do I put blog images?

Put the blog images into the images/blog folder

What format are blogs written in?

Markdown is used. Look at the existing blog posts if you need some help with formatting. Also, there are good formatting guides via https://github.com/eclipse/codewind-docs/wiki.

Learn to post by example

Header data

---
layout: post
title: "Introduction to Eclipse Codewind: Build high-quality cloud-native applications faster"
categories: blog
author_picture: images/blog/author_icon_andy_watson.jpeg
author_url: 
author: Andy Watson
blog_description: "Eclipse Codewind is an open source project that makes it easier for developers to create cloud-native applications within their favorite IDE. Codewind initially supports Visual Studio Code, Eclipse..."
permalink: introduction-to-eclipse-codewind-build-high-quality-cloud-native-applications-faster.html
duration: 2 minutes
tags: [Microservices, Containers, Nodejs, Java, Cloud]
---
  • layout is always post. The layout is generated from _layouts/post.html
  • title is your post title
  • categories is blog
  • author_picture is the avatar that shows up on the blog preview page blog.html
  • author_url is currently not used, but it can be used to reference a website the author would like to have when they click on the user's name. (e.g. LinkedIn, Twitter, etc.)
  • blog_description is a description of the post. This description shows up on the blog preview page blog.html, so it should be brief
  • permalink should match your file name. For all blogs and guides, add .html at the end. The links break if we do not have .html.
  • duration is the time it takes to read the entry
  • tags is an array of tags. Tags are currently not used in our blog framework, but will be in the future

After the header data

Start using markdown to write your post. You are allowed to use HTML.

Center aligned captions and images

The blog's CSS automatically centre aligns all images by default. To make the caption center aligned, use the text-align {: style="text-align: center;"} right under the image caption

![image of code in VS Code](images/blog/technicalautopsy_2.png){:width="800px"}
*code extract*
{: style="text-align: center;"}

Center align embedded YouTube videos

YouTube gives you an embedded HTML snippet when sharing the video. Surround that with a <div style="text-align: center;"></div> to center align the video

<div style="text-align: center;"><iframe width="560" height="315" src="https://www.youtube.com/embed/mjADP2_4FBg" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>

Large images have their widths specified

Add the {:width="800px"} to specify a width

![image of code in VS Code](images/blog/technicalautopsy_2.png){:width="800px"}
*code extract*
{: style="text-align: center;"}

External links target blank

To ensure a new tab or window opens use {:target="_blank"}. Pages within the codewind.dev website can open in the same page

Contribute to the project: [Visit GitHub](https://github.com/eclipse/codewind){:target="_blank"}

Code snippets

Use the to add large code snippets, you can add a language after likexml to get better syntax highlighting. If you are putting the code snippet into a list, the indent will be wrong, so you can optionally use HTML to inject a correctly colour formatted snippet

Blog review process

  • Technical review: Ensure your blog is technically accurate.
  • Grammar review: Ensure your blog follows good grammar and style.
  • Advocacy review: Ensure your blog aligns with content strategy.

How often are blog posts published?

Blog posts will be published once a release.

Clone this wiki locally