跳到主要内容

Blog Submission

Thank you for contributing to DevLake blog! We can't wait to hear your voice!

Because DevLake only accepts blog posts submitted through PRs, we want to make this process as painless as poissble by putting together this instruction.

Overview

The DevLake website maintains blog posts in two languages, English and Chinese(simplified), so we prefer that you submit your blog posts in both languages. However, if you are only familiar with one language, you can submit your blog posts in one language--either English or Chinese--but please put the same files in both directories of the two languages. We will help you with the translation based on our current work capacity.

English blog directory: blog/your-blog-post

Chinnese blog directory: i18n/zh/docusaurus-plugin-content-blog/your-blog-post

Notice: No matter if you are submitting blog posts in one or two languages, please follow both the English and Chinese instructions as follows:

Steps - English

  1. If you are submitting for the first time please add your author info by going into the blog directory, find the file named authors.yml and add your author info in the format of:
warren:
name: Warren Chen
title: DevLake Contributor
url: https://github.com/warren830
image_url: https://github.com/warren830.png

If you are not submitting for the first time, please skip this step and go to Step No.2.

  1. In the blog directory, create a folder for a single blog post and name it in the format of yyyy-mm-dd-your-blog-post-title, so that all blog posts will be arranged in the order of time automatically.

  2. Inside this folder, create a markdownfile and name it index.md. All of your blog post content goes into this file. If you use any images in your blog post, please also place the image files in the same folder.

  3. In the beginning of index.md, please add the following information to help with the SEO:

---
slug: your-blog-post-title
title: Your Blog Post Title
authors: warren
tags: [DevLake, ants, deadlock]
---

Please make sure that the value for authors match the author info you entered in authors.yml.

  1. For better viewing experience, only a truncated section of each blog post will be displayed as a summary on the Blog page's overview. So please place <!--truncate--> at an appropriate place in your index.md. (We recommend putting it after approximately 300 words, but it is flexible as long as you think it make sense.) For example:
---
slug: truncation-example
title: Truncation Example
authors: yumeng
tags: [DevLake, blog]
---

All these will be part of the blog post summary.

Even this.

<!--truncate-->

But anything from here on down will not be.

Not this.

Or this.

Steps - Chinese(Simplified)

The steps for submitting the Chinese version of your blog post are very similar to those of English, but in a different directory with a few tweaks.

  1. If you are submitting for the first time please add your author info by going into the i18n/zh/docusaurus-plugin-content-blog directory, find the file named authors.yml and add your author info in the format of:
warren:
name: 陈映初
title: DevLake贡献者
url: https://github.com/warren830
image_url: https://github.com/warren830.png

If you are not submitting for the first time, please skip this step and go to Step No.2.

  1. In the i18n/zh/docusaurus-plugin-content-blog directory, create a folder for a single blog post and name it with the exact the name of the blog post folder that you have used for the English submission, so that the two files for two languages can match automatically.

  2. Inside this folder, create a markdownfile and name it index.md. All of your blog post content goes into this file. If you use any images in your blog post, please also place the image files in the same folder.

  3. In the beginning of index.md, please add the following information to help with the SEO:

---
slug: your-blog-post-title
title: 你的文章题目
authors: warren
tags: [DevLake, ants, deadlock]
---

Please make sure that the value for authors match the author info you entered in authors.yml.

  1. For better viewing experience, only a truncated section of each blog post will be displayed as a summary on the Blog page's overview. So please place <!--truncate--> at an appropriate place in your index.md. (We recommend putting it after approximately 200 Chinese characters, but it is flexible as long as you think it make sense.) For example:
---
slug: truncation-example
title: Truncation Example
authors: yumeng
tags: [DevLake, blog]
---

All these will be part of the blog post summary.

Even this.

<!--truncate-->

But anything from here on down will not be.

Not this.

Or this.

After completing the above steps, please submit a PR to apache/incubator-devlake-website for review. Happy blogging!