This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 9c82d7835f docs: update blog submission guideline file (#468)
9c82d7835f is described below
commit 9c82d7835ffdc526ab694048570864596937df1c
Author: Joshua Poddoku <[email protected]>
AuthorDate: Mon Mar 20 18:31:47 2023 +0530
docs: update blog submission guideline file (#468)
* Updated Blog Submission Guidelines and minor typos
* Updated walkthrough example topics
* Removed chinese guidelines and fixed comments
---
community/make-contribution/BlogSubmission.md | 79 +++++++--------------------
1 file changed, 19 insertions(+), 60 deletions(-)
diff --git a/community/make-contribution/BlogSubmission.md
b/community/make-contribution/BlogSubmission.md
index 88530ab863..ba6076eae4 100644
--- a/community/make-contribution/BlogSubmission.md
+++ b/community/make-contribution/BlogSubmission.md
@@ -7,7 +7,24 @@ description: >
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.
+Because DevLake only accepts blog posts submitted through PRs, we want to make
this process as painless as possible by putting together this instruction.
+
+## Guidelines
+
+The objective of creating blogs is to educate the community, we advise you to
read the following guidelines:
+
+1. Before writing the blog, we recommend that you install DevLake and build a
practical use case.
+2. **Recommended Topics** are listed in the table below.
+
+ _[Updated on 20th March 2023]_
+
+| No.| Objective | Type | Example Blogs / Topics |
+|---| ------ | --------------| ------------ |
+| 1.| Walkthrough of setup in your own toolchains | Installation | E.g.
"Setting Up DevLake with GitLab and Jenkins", "Getting started with DevLake
using GitHub, Argo, etc." |
+| 2.| Critical troubleshooting blogs while using DevLake | Troubleshooting |
Check out the examples from [troubleshooting
docs](https://devlake.apache.org/docs/Troubleshooting/) |
+| 3.| Your own experience of using specific feature(s) and/ or plugin(s). |
Use-cases | E.g. "How to use Jira, GitLab and Jenkins to measure DORA metrics",
"How to get the team configured in Apache DevLake", "How to create your own
dev-metrics with DevLake". |
+
+
## Overview
@@ -15,9 +32,6 @@ The DevLake website maintains blog posts in two languages,
English and Chinese(s
**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:
@@ -70,60 +84,5 @@ 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:
-
-```markdown
-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.
-
-2. 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.
-
-3. Inside this folder, create a `markdown`file 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.
-
-4. In the beginning of `index.md`, please add the following information to
help with the SEO:
-
-```markdown
----
-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`.
-
-5. 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:
-
-```markdown
----
-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](https://github.com/apache/incubator-devlake-website)
for review. Happy blogging!
\ No newline at end of file
+After completing the above steps, please submit a PR to
[apache/incubator-devlake-website](https://github.com/apache/incubator-devlake-website)
for review. Happy blogging!
