Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 5.17 KB

README.md

File metadata and controls

109 lines (77 loc) · 5.17 KB
Raw

Contributing to the blog

  1. Create an issue in the repository for your blog post.
  2. Fork this repository and clone.
  3. Create a new blog post file in the drafts folder with the file name post-title.adoc.
  4. Write your blog post in there then create a pull request (linked to the issue you created in Step 0) with @lauracowen and anyone else as reviewer.
  5. After resolving any problems and making any edits, Laura will publish the post by moving it to the publish folder and renaming the file to YYYY-MM-DD-post-title.adoc.

Blogs are written in AsciiDoc format with a file extension of .adoc.

In the blog post file the following front matter variables must be set:

  • layout: post
  • title: title of the blog post
  • categories: blog
  • author_picture: secure url to author picture
  • author_github: secure url to author github
  • blog_description: Description of blog post used in the preview card on openliberty.io/blog
    • Please keep your blog_description to around 60 words
  • seo-title: Blog Title used in search results and on social media - OpenLiberty.io
    • Please ensure that your seo-title ends with - OpenLiberty.io
  • seo-description: Blog Description used in search results and on social media
    • Please keep your seo-description between 50-300 characters

drafts folder contains blog posts that are still in draft and are not ready to be published

publish folder contains blog posts that are ready to be published

img/blog folder contains images used in the blog adoc files

Once approved (ask lauracowen, or NottyCode as backup, to review/approve your PR), the blog post will be moved from drafts to publish.

Adding tags to your blog post

To add tags to your post, please open a pull request with your edits to blog_tags.json. You simply need to add the title of your post (without the date and file extension) to the posts array under the tags you want to use. (For example, if the file name is 2019-08-15-blog-post.adoc, you would just add "blog-post").

You can request a review from lauracowen or ellenwyllie if you are unsure who to ask.

Blog posts with multiple authors

If you would like to publish a blog post with more than 1 author, you can add the additional_authors attribute to the liquid front matter. Any number of additional authors can be specified using the following format:

additional_authors: 
 - name: author 2 first and last name
   github: secure url to author 2 github
   image: secure url to author 2 picture
 - name:  author 3 first and last name
   github: secure url to author 3 github
   image: secure url to author 3 picture

Contributing a third party blog post

If you would like to add a blog post that is actually a link to an existing third party blog post, you can follow the normal steps described above for creating a blog post. You simply need to add the following attributes to the liquid front matter:

  • redirect_link: secure_url_to_3rd_party_post
  • permalink: /blog/redirected.html

Also provide a level 1 heading eg:

= Creating a cool app with MicroProfile

Troubleshooting

Certain characters (eg apostrophe ' ) in the main heading are displayed incorrectly. To fix, escape with a backslash (\). eg = Minimise turnaround times with Open Liberty\'s dev mode

Docker container for development

Github.com does a pretty good job of rendering asciidoc so you can preview your file there, but to see exactly what it will look like you'll need to install the website software and run it.

Running the website on your local machine

git clone https://github.com/OpenLiberty/blogs.git
git clone https://github.com/OpenLiberty/openliberty.io.git
docker pull kinueng/openliberty.io

Replace "currentFolder" in the following command with the full path to the folder you are in.

docker run --rm --name website -it -p 4000:4000 -v currentFolder/openliberty.io:/home/jekyll kinueng/openliberty.io

# example when current directory is /Users/bruce/projects/blog/website:
# docker run --name website -it -p 4000:4000 -v /Users/bruce/projects/blog/website/openliberty.io:/home/jekyll kinueng/openliberty.io

Update the running container with your edits

Before your new or updated blog entry will appear on the website, you will need to run the script below to update the container with your latest changes, then wait for the container to finish processing them. Then you can see your changes at http://localhost:4000/blog/

Note that blogs named with dates in the future, e.g. 2099-01-05, will not be shown, so don't do that.

./blogs/scripts/refresh_docker_image.sh

How to know when your changes are rendered by the container

You will see Jekyll detect your new files and regenerate the blog files. You will want to wait for the line "...done in XXXX seconds."

      Regenerating: 101 file(s) changed at 2018-10-29 18:53:10
      ...
      Jekyll Feed: Generating feed for posts
      ...
            ...done in 121.8705398 seconds.