Regarding to improvement to openeuler's wiki and issues handling on gitee
Infra team: On behave of TC, I’m proposing following changes to openEuler infrastructure for your consideration. 1. Regarding to Wiki Background: We think Wiki is a good way to consolidate and present knowledge systematically. openEuler already has its own document site (https://openeuler.org/zh/docs), we think it could be further improved. a) The namespace of pages should be flattened. For example, https://openeuler.org/zh/docs/Administration/简介.html , the name of page implies to be an introduction to system administration. But in fact, it’s an introduction to system only. We propose to add directories for each domain. b) Currently documents are divided into different SIG, we think it’s important to extend it for multiple SIG. For example, if we introduce oVirt into openEuler, the document of oVirt should be part of the https://openeuler.org/zh/docs/Virtualization, not it’s own. c) It’s very different to use cross reference now. We think it is an important feature to have. For example, https://openeuler.org/zh/docs/Administration/设置语言环境.html should refer to systemd. It’ difficult or even impossible to do so now. 2. Regarding to issues handling Background: There’re difficulties during day-to-day work on openEuler community. Especially, when issues are reported. We think it needs to be further improved. a) When an issue is reported, we think it’s very helpful to have it assigned to a default triage. The developers don’t know each other, and even they know each other, they can not match the ID with real people. The best way now is to assigned to a default triage based on the components or sub-module. b) There’re too many messages on the web interface. Developers are easily overwhelmed. We suggest to have a default mail notification for all un-handled or un-closed issue to assigned developers. If there’re existing mechanism we can leverage, please advise too. Looking forward to your feedback and suggestions. Shinwell Technical Committee openEuler Community
hi, Shinwell Thanks so much for your advise. please see my following inner response with ‘[freesky-edward]’ prefix and very appreciated to know your opinion. thanks very much. On Wed, Feb 26, 2020 at 2:35 PM Huxinwei via Tc <tc@openeuler.org> wrote:
Infra team:
On behave of TC, I’m proposing following changes to openEuler infrastructure for your consideration.
1. Regarding to Wiki
Background: We think Wiki is a good way to consolidate and present knowledge systematically. openEuler already has its own document site ( https://openeuler.org/zh/docs),
we think it could be further improved.
a) The namespace of pages should be flattened. For example, https://openeuler.org/zh/docs/Administration/简介.html , the name of page implies to be an introduction
to system administration. But in fact, it’s an introduction to system only. We propose to add directories for each domain.
[freesky-edward]IMHO, regarding to current docs showing on website which maintains by docs team with a independent project, the project's name is docs[1]https://gitee.com/openeuler/docs. they can organize the docs folders as they expect please refer to https://gitee.com/openeuler/docs/blob/master/content/zh/menu/index.md. infrastructure team only provide the basic framework and publish flows. this may be an approvement issue on docs project.
b) Currently documents are divided into different SIG, we think it’s important to extend it for multiple SIG. For example, if we introduce oVirt into openEuler, the document
of oVirt should be part of the https://openeuler.org/zh/docs/Virtualization, not it’s own.
[freesky-edward] If I understand corectly, the published docs does't organize by sigs instead of system feature. and I totally agree to add oVirt into Virtualization since I think that will help user to understand the folder index.
c) It’s very different to use cross reference now. We think it is an important feature to have. For example, https://openeuler.org/zh/docs/Administration/设置语言环境.html
should refer to systemd. It’ difficult or even impossible to do so now.
[freesky-edward] +1, I think this is a point should be improved. let's open issue to trace it.
2. Regarding to issues handling
Background: There’re difficulties during day-to-day work on openEuler community. Especially, when issues are reported. We think it needs to be further improved.
a) When an issue is reported, we think it’s very helpful to have it assigned to a default triage. The developers don’t know each other, and even they know each other, they can
not match the ID with real people. The best way now is to assigned to a default triage based on the components or sub-module.
b) There’re too many messages on the web interface. Developers are easily overwhelmed. We suggest to have a default mail notification for all un-handled or un-closed issue
to assigned developers. If there’re existing mechanism we can leverage, please advise too
[freesky-edward] agree. could you please check whether this way can fix this that trying to build a mention-bot which will spect the PR or issue create and reply a message with @ the project's maintainers to notice this. so that the mentioned maitainers will recieve the notification. the way of the notification can either be email or gitee message, which depends on the user configuration on gitee. that looks like the openeule-ci-bot reponse the CLA check result https://gitee.com/openeuler/community/pulls/194 the difference is the reponse message. Looking forward to your feedback and suggestions.
Shinwell
Technical Committee
openEuler Community
_______________________________________________ Tc mailing list -- tc@openeuler.org To unsubscribe send an email to tc-leave@openeuler.org
-- Edward Lee ----------------------------------------------------------- Email: freesky-edward@gamil.com Phone: 0086-18200191386 Twitter: https://twitter.com/EdwardL0086 Address: Chengdu City, Sichuan Privince, China
Edward: I’ll try gitee.com/openEuler/docs before we can further discuss how to improve it ;) Regarding to issue tracking, I’d like to understand the design and implementation of openEuler-ci-bot first. Where can I find it ? Regards Xinwei From: Edward Lee [mailto:freesky.edward@gmail.com] Sent: Wednesday, February 26, 2020 11:23 PM To: Huxinwei <huxinwei@huawei.com> Cc: infra@openeuler.org; tc@openeuler.org; Xiexiuqi <xiexiuqi@huawei.com>; Liyongle (Fred) <liyongle@huawei.com>; Lizhonghua (OpenSource) <lizhonghua.li@huawei.com>; wufengguang <wufengguang@huawei.com> Subject: Re: [Tc] Regarding to improvement to openeuler's wiki and issues handling on gitee hi, Shinwell Thanks so much for your advise. please see my following inner response with ‘[freesky-edward]’ prefix and very appreciated to know your opinion. thanks very much. On Wed, Feb 26, 2020 at 2:35 PM Huxinwei via Tc <tc@openeuler.org<mailto:tc@openeuler.org>> wrote: Infra team: On behave of TC, I’m proposing following changes to openEuler infrastructure for your consideration. 1. Regarding to Wiki Background: We think Wiki is a good way to consolidate and present knowledge systematically. openEuler already has its own document site (https://openeuler.org/zh/docs), we think it could be further improved. a) The namespace of pages should be flattened. For example, https://openeuler.org/zh/docs/Administration/简介.html , the name of page implies to be an introduction to system administration. But in fact, it’s an introduction to system only. We propose to add directories for each domain. [freesky-edward]IMHO, regarding to current docs showing on website which maintains by docs team with a independent project, the project's name is docs[1]https://gitee.com/openeuler/docs. they can organize the docs folders as they expect please refer to https://gitee.com/openeuler/docs/blob/master/content/zh/menu/index.md. infrastructure team only provide the basic framework and publish flows. this may be an approvement issue on docs project. b) Currently documents are divided into different SIG, we think it’s important to extend it for multiple SIG. For example, if we introduce oVirt into openEuler, the document of oVirt should be part of the https://openeuler.org/zh/docs/Virtualization, not it’s own. [freesky-edward] If I understand corectly, the published docs does't organize by sigs instead of system feature. and I totally agree to add oVirt into Virtualization since I think that will help user to understand the folder index. c) It’s very different to use cross reference now. We think it is an important feature to have. For example, https://openeuler.org/zh/docs/Administration/设置语言环境.html should refer to systemd. It’ difficult or even impossible to do so now. [freesky-edward] +1, I think this is a point should be improved. let's open issue to trace it. 2. Regarding to issues handling Background: There’re difficulties during day-to-day work on openEuler community. Especially, when issues are reported. We think it needs to be further improved. a) When an issue is reported, we think it’s very helpful to have it assigned to a default triage. The developers don’t know each other, and even they know each other, they can not match the ID with real people. The best way now is to assigned to a default triage based on the components or sub-module. b) There’re too many messages on the web interface. Developers are easily overwhelmed. We suggest to have a default mail notification for all un-handled or un-closed issue to assigned developers. If there’re existing mechanism we can leverage, please advise too [freesky-edward] agree. could you please check whether this way can fix this that trying to build a mention-bot which will spect the PR or issue create and reply a message with @ the project's maintainers to notice this. so that the mentioned maitainers will recieve the notification. the way of the notification can either be email or gitee message, which depends on the user configuration on gitee. that looks like the openeule-ci-bot reponse the CLA check result https://gitee.com/openeuler/community/pulls/194 the difference is the reponse message. Looking forward to your feedback and suggestions. Shinwell Technical Committee openEuler Community _______________________________________________ Tc mailing list -- tc@openeuler.org<mailto:tc@openeuler.org> To unsubscribe send an email to tc-leave@openeuler.org<mailto:tc-leave@openeuler.org> -- Edward Lee ----------------------------------------------------------- Email: freesky-edward@gamil.com<mailto:freesky-edward@gamil.com> Phone: 0086-18200191386 Twitter: https://twitter.com/EdwardL0086 Address: Chengdu City, Sichuan Privince, China
participants (2)
-
Edward Lee -
Huxinwei