docs: Develop writing specification and template for APISIX Chinese Documentation.

[guitu168]

Current State

Because the articles of Apache APISIX are contributed by different people, the current format of document is not uniform, the style of writing is not uniform, the terms are not unified, and the structure is not unified. 中文描述：由于 Apache APISIX 的文章是由不同的人贡献的，因此当前文档存格式不统一、写作风格不统一、用词不统一、架构不统一等问题。

Desired State

I want to develop a Apache APISIX Chinese document writing standard for the reference and moderator of document contributors. At the end of March, I will show the first draft. If you have more ideas, please let me know. It mainly includes document writing specification and document writing template.

1. Document writing specification: including the correct writing method of common words, code format, name examples, usage rules of mark pairs, glossary, etc.
2. Document writing template: including principle documents, operation documents, etc.

The following is the completed part, please check: Personal pronouns, IP addresses and domain names, punctuation, operators, sentences, tables, pictures, word spacing, lists, notes, links, marker pairs, code segments, links, prohibited words, terms, etc.

中文描述： 因此，我想制定一份 Apache APISIX 中文文档写作标准，以供文档贡献者参考和审核者审查。3月底，我会展示初稿。如果你有更多的想法，请告诉我。 规范内容主要包括文档写作规范和文档写作模板。

1. 文档写作规范：包括常用词的正确写法，代码格式，名称示例，标记对使用规则，术语表等内容。
2. 文档写作模板：包括原理类文档， 操作类文档等内容。 以下是已完成部分，请查看： 人称代词、 IP 地址和域名、标点符号、运算符、句子、表格、图片、字间距、列表、Note、链接、标记对、代码段、链接、违禁词、术语等。

[juzhiyuan]

Hi @hf400159, glad to see this issue! I would suggest you could work with @navendu-pottekkat together to propose a Style Guide, and then you could present one for Chinese. @navendu-pottekkat is on the ASF Slack channel.

[pottekkat]

@juzhiyuan @hf400159 Here is my suggestion: https://github.com/apache/apisix/issues/6528#issuecomment-1064011458

I will open up an issue and draft a style guide next week and we can collaborate.

[juzhiyuan]

Thanks, also cc @kwanhur

[guitu168]

@navendu-pottekkat Thank you for your suggestion, I hoped we can cooperate happily, It's a pleasure doing business with you If possible, I will create a style guide for APISIX Chinese documentation.

[pottekkat]

@hf400159 Awesome! There would be some overlaps in the style guide like how to include code snippets, and how to comment on code snippets etc.

[guitu168]

@navendu-pottekkat ok, I'll be discussing with you next week via Slack.

[liangliang4ward]

at chinese doc parmaters table head, Requirement some docs translate to "必选项", some docs translate to "可选项” and some translate to "是否必须". we should unify.

like :

https://github.com/apache/apisix/blob/a47dab7eecd90998499eae10b477ce7fd8175c28/docs/zh/latest/plugins/file-logger.md?plain=1#L30

https://github.com/apache/apisix/blob/a47dab7eecd90998499eae10b477ce7fd8175c28/docs/zh/latest/plugins/google-cloud-logging.md?plain=1#L35

https://github.com/apache/apisix/blob/a47dab7eecd90998499eae10b477ce7fd8175c28/docs/zh/latest/plugins/traffic-split.md?plain=1#L32

[juzhiyuan]

I would prefer to use: 必填：是/否 -> Required: Yes, No

[liangliang4ward]

I would prefer to use: 必填：是/否 -> Required: Yes, No

agree

[guitu168]

Yes, that was part of my plan. we will unify the plugin document style.

[liangliang4ward]

the parameter table head column "Is it necessary" In en/.md is Required and value is Yes/No; In zh/.md is 必填 and value is 是/否.

https://github.com/apache/apisix/pull/6668#issuecomment-1077400744

[github-actions[bot]]

This issue has been marked as stale due to 350 days of inactivity. It will be closed in 2 weeks if no further activity occurs. If this issue is still relevant, please simply write any comment. Even if closed, you can still revive the issue at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.

[pottekkat]

@guitu168 Are you still interested in working on this issue? We have a style guide now for the English documentation. Maybe you can suggest additions and also create a Chinese equivalent?

[ro4i7]

@navendu-pottekkat , i can solve this one, but i will take use of google translate. What you say?

[pottekkat]

@ro4i7 There would be fundamental differences between the English and the Chinese guides. Google Translate would not work here.

[github-actions[bot]]

This issue has been marked as stale due to 350 days of inactivity. It will be closed in 2 weeks if no further activity occurs. If this issue is still relevant, please simply write any comment. Even if closed, you can still revive the issue at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.