Skip to content

docs: update blog submission guideline file#468

Merged
Startrekzky merged 4 commits intomainfrom
unknown repository
Mar 20, 2023
Merged

docs: update blog submission guideline file#468
Startrekzky merged 4 commits intomainfrom
unknown repository

Conversation

@ghost
Copy link

@ghost ghost commented Mar 14, 2023

⚠️   Pre Checklist

Please complete ALL items in this checklist, and remove before submitting

  • I have npm run build and npm run serve locally before submitting this PR
  • I have read through the Contributing Documentation

Summary

Does this close any open issues?

Closes apache/incubator-devlake#4283

Screenshots

NA

Other Information

NA


| No.| Objective | Type | Example Blogs / Topics |
|---| ------ | --------------| ------------ |
| 1.| Walkthrough of setup in your own toolchains | Installation | Eg: "Setting Up DevLake with GitLab and Jenkins", "Getting started with DevLake using GitHub, Argo, etc." |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change 'Eg' to 'E.g.'?

|---| ------ | --------------| ------------ |
| 1.| Walkthrough of setup in your own toolchains | Installation | Eg: "Setting Up DevLake with GitLab and Jenkins", "Getting started with DevLake using GitHub, Argo, etc." |
| 2.| Critical troubleshooting blogs while installing DevLake | Troubleshooting | Check out the examples from [Troubleshooting guide](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 PagerDuty", "GitLab and CircleCI to measure DORA metrics", "How to use team feature in Apache DevLake", "Creating your own dev-metrics with DevLake". |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text change:
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".

**English blog directory:** blog/your-blog-post

**Chinnese blog directory:** i18n/zh/docusaurus-plugin-content-blog/your-blog-post
**Chinese blog directory:** i18n/zh/docusaurus-plugin-content-blog/your-blog-post
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get rid of this one since we no longer accept Chinese blogs.

Copy link
Author

@ghost ghost Mar 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay @Startrekzky, so should I remove the whole Chinese section?


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... build a practical use case.

| No.| Objective | Type | Example Blogs / Topics |
|---| ------ | --------------| ------------ |
| 1.| Walkthrough of setup in your own toolchains | Installation | Eg: "Setting Up DevLake with GitLab and Jenkins", "Getting started with DevLake using GitHub, Argo, etc." |
| 2.| Critical troubleshooting blogs while installing DevLake | Troubleshooting | Check out the examples from [Troubleshooting guide](https://devlake.apache.org/docs/Troubleshooting/) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text changes:

  • Critical troubleshooting blogs while using DevLake
  • Check out the examples from the troubleshooting docs

Copy link
Contributor

@Startrekzky Startrekzky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Startrekzky Startrekzky merged commit 9c82d78 into apache:main Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc][Blog] Update Blog Submission guidelines

1 participant