From 39d91086e2203a3a7ebe62c4a8e15777084168d6 Mon Sep 17 00:00:00 2001 From: Michael Li Date: Wed, 14 Dec 2022 10:47:49 +0800 Subject: [PATCH] add discuss documents --- docs/README.md | 1 + docs/discuss/0000-讨论样式模版.md | 26 +++++++++++++++++++++++++ docs/discuss/0001-FAQs.md | 17 ++++++++++++++++ docs/discuss/README.md | 5 +++++ 4 files changed, 49 insertions(+) create mode 100644 docs/discuss/0000-讨论样式模版.md create mode 100644 docs/discuss/0001-FAQs.md create mode 100644 docs/discuss/README.md diff --git a/docs/README.md b/docs/README.md index d2c7b192..fda64147 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,3 +4,4 @@ * [openapi](openapi): api相关文档 * [proposal](proposal): 开发/设计 提按相关文档 * [deploy](deploy): 部署相关文档 +* [discuss](discuss): 开发者交流 diff --git a/docs/discuss/0000-讨论样式模版.md b/docs/discuss/0000-讨论样式模版.md new file mode 100644 index 00000000..a7e50871 --- /dev/null +++ b/docs/discuss/0000-讨论样式模版.md @@ -0,0 +1,26 @@ +### <主题标题> +====== <这里写主题描述> ===== + +#### <话题标题> +====== <这里写话题描述> ===== +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 这里就是你的观点论述了 + +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 这里就是你的观点论述了 + +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 这里就是你的观点论述了 + +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 这里就是你的观点论述了 + +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 这里就是你的回复 + >> 这里就是你的观点论述了 + +* [北野](https://alimy.me) - 2022/12/14 10:07 + > 你的回复 + >> 这里就是你的回复 + >>> 这里就是你的观点论述了 + diff --git a/docs/discuss/0001-FAQs.md b/docs/discuss/0001-FAQs.md new file mode 100644 index 00000000..5d45a73d --- /dev/null +++ b/docs/discuss/0001-FAQs.md @@ -0,0 +1,17 @@ +### FAQs 常见问题 +一些常见问题的解答。 + + +#### 为什么要在代码库[docs](../../docs/)中写开发文档，比如[proposal](../proposal/)提按文档？ +* [北野](https://alimy.me) - 2022/12/14 10:20 + > 这里有几个原因 + > * 开发文档跟随代码库对开发者友好； + > * paopao-ce的开发是离散组织式开发，代码寄存在GitHub，并没有一个统一的开发平台； + > * 为什么没有使用GitHub的Wiki写档？这个后续会把一些文档Copy到WiKi。 + > * 文档跟随代码，将更好的与代码共存，而且Markdown足够用于写文档，这才是最核心的，怎么简单怎么来。 + + +#### 为什么要在代码库[docs](../../docs/)中包含一个[discuss](../discuss/)?难道没有其他可用工具更好完成这种工作吗，比瑞slack/discord？ +* [北野](https://alimy.me) - 2022/12/14 10:32 + > discuss目录包含一些关于代码库开发的一些方案讨论，偏静态内容，代码库内置这些方案讨论，也便于git进行跟踪归档。 + > 确实有其他一些社交类开发聊天工具可用，比如slack/discord，但是目前paopao-ce的开发者社区还比较小，暂时还没有开通的必要，再一个国内访问也不是特别方便，暂时采用目前这种土办法过渡一下，或许后期会选择一个社交平台供开发者交流，比如飞书～ diff --git a/docs/discuss/README.md b/docs/discuss/README.md new file mode 100644 index 00000000..a957312b --- /dev/null +++ b/docs/discuss/README.md @@ -0,0 +1,5 @@ +### Discuss 开发者交流 +本目录包含一些开发相关的问题交流论述。 + +* [0000-讨论样式模版](./0000-讨论样式模版.md "讨论样式模版") +* [0001-讨论样式模版](./0001-FAQs.md "FAQs")