Hi Serendipity96 and Yeliang,

Thank you for your suggestions!

For the suggestion of adding a blog template,  please see Blog's header 
information[1]. I have added a template and explainations.

For the suggestion of adding blog catelogs, it is very inspirational. Catalogs 
are already implemented, and I add some description[2] about them in the 
guideline as well. The catelogs are essentially implemented using 'tags'. But 
after some researching, tags has certain limitations[3] when the input is 
Chinese. Then this suggestion is partially solved. The remaining questions are:

1. Should we divide tags into English and Chinese?
2. Are the tags we have enough? If not, what tags should we add?
3. How to distribute tags to blogs in certain standards or rules? Like [2], we 
have a set of rules when applying tags to blogs. When we add new tags, it is 
always good to develop rules of applying them as well.

I would prefer to leave them as it is right now, and open another discussion 
specifically for the blog catalogs' topic, since it is too much for a pull 
request.

Regards,
Yilin

[1]https://github.com/apache/apisix-website/pull/776/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R44-R56
[2]https://github.com/apache/apisix-website/pull/776/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R86-R97
[3]https://zhuanlan.zhihu.com/p/430942362
________________________________
发件人: justserendipit...@gmail.com <justserendipit...@gmail.com>
发送时间: 2021年11月26日 14:48
收件人: dev@apisix.apache.org <dev@apisix.apache.org>
主题: Re: [Proposal] Add blog contribution guidelines to apisix-website repository

Hi Yilin,

Great idea!  I also think we should add contribution guidelines, it will
help new partners.

What do you think to add a blog template? just like:

1 What can you contribute
1.1 the way to add a new blog
1.2 Fix typos or formats
1.3 blog template


Looking forward++!

Best Regards,
@Serendipity96<https://github.com/Serendipity96>

Sylvia <sylvia.su...@gmail.com> 于2021年11月26日周五 14:27写道:

> Hi Yilin,
>
> I think this proposal is very good, and it is more convenient to help
> contributors who want to share content instantly.
>
> Look forward to the guideline!
>
> Best Regards,
> Sylvia
>
> Yilin Zeng <yzen...@wisc.edu.invalid> 于2021年11月26日周五 下午2:20写道:
>
> > Hi community,
> >
> >
> > Currently apisix-website repository[1] does not have a set of blog
> > contribution guidelines. It could block potential contributors who want
> to
> > write blogs but cannot find the proper way to do it. As I was reaching
> out
> > to other open-source communities in the last two weeks, I went through
> some
> > of theirs website and blog repositories, and found some valuable
> guidelines
> > that could be implemented in apisix-website repository[1], such as TiDB
> > Documentation Contributing Guide[2].
> >
> >
> > I would like to propose adding contribution guidelines to apisix-website
> > repository[1], which will cover the following aspects:
> >
> >
> > 1 What can you contribute
> > 1.1 Add a new blog
> > 1.2 Fix typos or formats
> >
> > 2 Contribute style guides
> > 2.1 Commit message style
> > 2.1 Pull request title style
> >
> > 3 How to contribute properly via git command line
> >
> >
> > Feel free to share your views, suggestions, or anything else. Thank you!
> >
> >
> > Regards,
> >
> > Yilin
> >
> >
> >
> > [1]https://github.com/apache/apisix-website
> >
> > [2]https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md
> >
> >
>

Reply via email to