Re: Taxonomy on our cwiki
Thanks, Qing. Plan is in the email. I thought about suggesting a wiki guideline, but on second thought I think once a good structure is in place, things would self-organize in that structure, and I don't want to intimidating people by forcing them to read :) After experimenting, by using the move tool in cwiki it doesn't seem to affect edit history or authorship, so I see no reason to bother others. Given the positive feedback in the last couple of days, I will go ahead move things around and report back the diff once finished (and I won't remove or modify content). -sz On Tue, Jan 22, 2019 at 10:09 AM Qing Lan wrote: > Agreed +1. > Could we draft a plan on CWIKI and let's sign up our name to migrate the > pages to the right location? > > Thanks, > Qing > > On 1/21/19, 6:18 AM, "Anton Chernov" wrote: > > A quick tip about links to the wiki pages, note the difference in > links: > > * https://cwiki.apache.org/confluence/display/MXNET/Release+Process > (1) > * https://cwiki.apache.org/confluence/x/BINjB (2) > > If sharing was done via the 'Share' menu the link (2) would persist > after > any structual movements. > > Best > Anton > > > сб, 19 янв. 2019 г. в 16:49, Pedro Larroy < > pedro.larroy.li...@gmail.com>: > > > +1 > > > > On Sat, Jan 19, 2019 at 2:51 PM Zhao, Patric > > wrote: > > > > > > +1, Good idea. > > > > > > It's not very easy to find out the related contents since lots of > > folders in the website. > > > > > > > > > > -Original Message----- > > > > From: Sheng Zha [mailto:zhash...@apache.org] > > > > Sent: Saturday, January 19, 2019 3:28 AM > > > > To: dev@mxnet.incubator.apache.org > > > > Subject: Taxonomy on our cwiki > > > > > > > > Hi MXNet, > > > > > > > > Given that currently cwiki is the only place other than mxnet > website > > for > > > > mxnet-related documentation, I'd like to request your attention > to the > > > > (slightly disorganized) cwiki page of MXNet. The top level > folders > > (and their > > > > contents) currently looks like this: > > > > - Design Proposals* (bag of proposals, not in order) > > > > - Development* (mixture of guides, roadmaps, processes) > > > > - Release Process (release notes) > > > > - Website (guides and proposals) > > > > - MXNet Clojure (call for contribution, guides) > > > > - MXNet Keras Integration (design) > > > > - MXNet-ONNX Integration (design, dev status) > > > > - MXNet R Package (guide, backlog) > > > > - MXNet-Scala (design, dev status, guide) > > > > - Content Formatting Templates (not a folder but link to two > docs) > > > > - How-to articles (1 guide) > > > > - Community (guide on apache-related processes) > > > > - Data IO (designs) > > > > - Continuous Integration (guides, designs) > > > > - Meetups and Hangouts (events) > > > > > > > > And here are two good examples from successful Apache projects: > > > > - Apache Flink: an **audience-oriented** structure [1] > > > > Users (Presentations and How-to) > > > > Contributors (Dev processes and How-to) > > > > Committers (Infra, Dev processes, Release processes, Releases) > > > > Roadmaps and Feature Designs (archive) > > > > - Apache OpenNLP: a **content-oriented** structure [2] > > > > Guides > > > > External Resources > > > > Proposals > > > > Releasing > > > > > > > > Clean organization helps content discovery and saves time on > locating > > useful > > > > content. Given that we have good amount of content on the wiki > page, I > > > > suggest that we decide on a cleaner taxonomy, re-organize > contents > > > > accordingly, and add future contents accordingly. To provide a > > starting point > > > > for the discussion, I suggest: > > > > - Given the state we are in, start with content-oriented > organization, > > use > > > > these top-level categories: Guides (including processes and > how-tos), > > > > Development (including designs, proposals, notes, roadmaps), > Community > > > > (including events, activities, external resources and contents) > > > > - If people strongly prefer audience-oriented structure, later > we can > > adopt a > > > > structure similar to Flink's. > > > > > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > > > > > -sz > > > > > > > > [1] > > > > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttp > > > > s://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index > > > > >
Re: Taxonomy on our cwiki
Agreed +1. Could we draft a plan on CWIKI and let's sign up our name to migrate the pages to the right location? Thanks, Qing On 1/21/19, 6:18 AM, "Anton Chernov" wrote: A quick tip about links to the wiki pages, note the difference in links: * https://cwiki.apache.org/confluence/display/MXNET/Release+Process (1) * https://cwiki.apache.org/confluence/x/BINjB (2) If sharing was done via the 'Share' menu the link (2) would persist after any structual movements. Best Anton сб, 19 янв. 2019 г. в 16:49, Pedro Larroy : > +1 > > On Sat, Jan 19, 2019 at 2:51 PM Zhao, Patric > wrote: > > > > +1, Good idea. > > > > It's not very easy to find out the related contents since lots of > folders in the website. > > > > > > > -Original Message- > > > From: Sheng Zha [mailto:zhash...@apache.org] > > > Sent: Saturday, January 19, 2019 3:28 AM > > > To: dev@mxnet.incubator.apache.org > > > Subject: Taxonomy on our cwiki > > > > > > Hi MXNet, > > > > > > Given that currently cwiki is the only place other than mxnet website > for > > > mxnet-related documentation, I'd like to request your attention to the > > > (slightly disorganized) cwiki page of MXNet. The top level folders > (and their > > > contents) currently looks like this: > > > - Design Proposals* (bag of proposals, not in order) > > > - Development* (mixture of guides, roadmaps, processes) > > > - Release Process (release notes) > > > - Website (guides and proposals) > > > - MXNet Clojure (call for contribution, guides) > > > - MXNet Keras Integration (design) > > > - MXNet-ONNX Integration (design, dev status) > > > - MXNet R Package (guide, backlog) > > > - MXNet-Scala (design, dev status, guide) > > > - Content Formatting Templates (not a folder but link to two docs) > > > - How-to articles (1 guide) > > > - Community (guide on apache-related processes) > > > - Data IO (designs) > > > - Continuous Integration (guides, designs) > > > - Meetups and Hangouts (events) > > > > > > And here are two good examples from successful Apache projects: > > > - Apache Flink: an **audience-oriented** structure [1] > > > Users (Presentations and How-to) > > > Contributors (Dev processes and How-to) > > > Committers (Infra, Dev processes, Release processes, Releases) > > > Roadmaps and Feature Designs (archive) > > > - Apache OpenNLP: a **content-oriented** structure [2] > > > Guides > > > External Resources > > > Proposals > > > Releasing > > > > > > Clean organization helps content discovery and saves time on locating > useful > > > content. Given that we have good amount of content on the wiki page, I > > > suggest that we decide on a cleaner taxonomy, re-organize contents > > > accordingly, and add future contents accordingly. To provide a > starting point > > > for the discussion, I suggest: > > > - Given the state we are in, start with content-oriented organization, > use > > > these top-level categories: Guides (including processes and how-tos), > > > Development (including designs, proposals, notes, roadmaps), Community > > > (including events, activities, external resources and contents) > > > - If people strongly prefer audience-oriented structure, later we can > adopt a > > > structure similar to Flink's. > > > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > > > -sz > > > > > > [1] > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttp > > > s://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index >
Re: Taxonomy on our cwiki
A quick tip about links to the wiki pages, note the difference in links: * https://cwiki.apache.org/confluence/display/MXNET/Release+Process (1) * https://cwiki.apache.org/confluence/x/BINjB (2) If sharing was done via the 'Share' menu the link (2) would persist after any structual movements. Best Anton сб, 19 янв. 2019 г. в 16:49, Pedro Larroy : > +1 > > On Sat, Jan 19, 2019 at 2:51 PM Zhao, Patric > wrote: > > > > +1, Good idea. > > > > It's not very easy to find out the related contents since lots of > folders in the website. > > > > > > > -Original Message- > > > From: Sheng Zha [mailto:zhash...@apache.org] > > > Sent: Saturday, January 19, 2019 3:28 AM > > > To: dev@mxnet.incubator.apache.org > > > Subject: Taxonomy on our cwiki > > > > > > Hi MXNet, > > > > > > Given that currently cwiki is the only place other than mxnet website > for > > > mxnet-related documentation, I'd like to request your attention to the > > > (slightly disorganized) cwiki page of MXNet. The top level folders > (and their > > > contents) currently looks like this: > > > - Design Proposals* (bag of proposals, not in order) > > > - Development* (mixture of guides, roadmaps, processes) > > > - Release Process (release notes) > > > - Website (guides and proposals) > > > - MXNet Clojure (call for contribution, guides) > > > - MXNet Keras Integration (design) > > > - MXNet-ONNX Integration (design, dev status) > > > - MXNet R Package (guide, backlog) > > > - MXNet-Scala (design, dev status, guide) > > > - Content Formatting Templates (not a folder but link to two docs) > > > - How-to articles (1 guide) > > > - Community (guide on apache-related processes) > > > - Data IO (designs) > > > - Continuous Integration (guides, designs) > > > - Meetups and Hangouts (events) > > > > > > And here are two good examples from successful Apache projects: > > > - Apache Flink: an **audience-oriented** structure [1] > > > Users (Presentations and How-to) > > > Contributors (Dev processes and How-to) > > > Committers (Infra, Dev processes, Release processes, Releases) > > > Roadmaps and Feature Designs (archive) > > > - Apache OpenNLP: a **content-oriented** structure [2] > > > Guides > > > External Resources > > > Proposals > > > Releasing > > > > > > Clean organization helps content discovery and saves time on locating > useful > > > content. Given that we have good amount of content on the wiki page, I > > > suggest that we decide on a cleaner taxonomy, re-organize contents > > > accordingly, and add future contents accordingly. To provide a > starting point > > > for the discussion, I suggest: > > > - Given the state we are in, start with content-oriented organization, > use > > > these top-level categories: Guides (including processes and how-tos), > > > Development (including designs, proposals, notes, roadmaps), Community > > > (including events, activities, external resources and contents) > > > - If people strongly prefer audience-oriented structure, later we can > adopt a > > > structure similar to Flink's. > > > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > > > -sz > > > > > > [1] > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttp > > > s://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index >
Re: Taxonomy on our cwiki
+1 On Sat, Jan 19, 2019 at 2:51 PM Zhao, Patric wrote: > > +1, Good idea. > > It's not very easy to find out the related contents since lots of folders in > the website. > > > > -Original Message- > > From: Sheng Zha [mailto:zhash...@apache.org] > > Sent: Saturday, January 19, 2019 3:28 AM > > To: dev@mxnet.incubator.apache.org > > Subject: Taxonomy on our cwiki > > > > Hi MXNet, > > > > Given that currently cwiki is the only place other than mxnet website for > > mxnet-related documentation, I'd like to request your attention to the > > (slightly disorganized) cwiki page of MXNet. The top level folders (and > > their > > contents) currently looks like this: > > - Design Proposals* (bag of proposals, not in order) > > - Development* (mixture of guides, roadmaps, processes) > > - Release Process (release notes) > > - Website (guides and proposals) > > - MXNet Clojure (call for contribution, guides) > > - MXNet Keras Integration (design) > > - MXNet-ONNX Integration (design, dev status) > > - MXNet R Package (guide, backlog) > > - MXNet-Scala (design, dev status, guide) > > - Content Formatting Templates (not a folder but link to two docs) > > - How-to articles (1 guide) > > - Community (guide on apache-related processes) > > - Data IO (designs) > > - Continuous Integration (guides, designs) > > - Meetups and Hangouts (events) > > > > And here are two good examples from successful Apache projects: > > - Apache Flink: an **audience-oriented** structure [1] > > Users (Presentations and How-to) > > Contributors (Dev processes and How-to) > > Committers (Infra, Dev processes, Release processes, Releases) > > Roadmaps and Feature Designs (archive) > > - Apache OpenNLP: a **content-oriented** structure [2] > > Guides > > External Resources > > Proposals > > Releasing > > > > Clean organization helps content discovery and saves time on locating useful > > content. Given that we have good amount of content on the wiki page, I > > suggest that we decide on a cleaner taxonomy, re-organize contents > > accordingly, and add future contents accordingly. To provide a starting > > point > > for the discussion, I suggest: > > - Given the state we are in, start with content-oriented organization, use > > these top-level categories: Guides (including processes and how-tos), > > Development (including designs, proposals, notes, roadmaps), Community > > (including events, activities, external resources and contents) > > - If people strongly prefer audience-oriented structure, later we can adopt > > a > > structure similar to Flink's. > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > -sz > > > > [1] > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttp > > s://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index
RE: Taxonomy on our cwiki
+1, Good idea. It's not very easy to find out the related contents since lots of folders in the website. > -Original Message- > From: Sheng Zha [mailto:zhash...@apache.org] > Sent: Saturday, January 19, 2019 3:28 AM > To: dev@mxnet.incubator.apache.org > Subject: Taxonomy on our cwiki > > Hi MXNet, > > Given that currently cwiki is the only place other than mxnet website for > mxnet-related documentation, I'd like to request your attention to the > (slightly disorganized) cwiki page of MXNet. The top level folders (and their > contents) currently looks like this: > - Design Proposals* (bag of proposals, not in order) > - Development* (mixture of guides, roadmaps, processes) > - Release Process (release notes) > - Website (guides and proposals) > - MXNet Clojure (call for contribution, guides) > - MXNet Keras Integration (design) > - MXNet-ONNX Integration (design, dev status) > - MXNet R Package (guide, backlog) > - MXNet-Scala (design, dev status, guide) > - Content Formatting Templates (not a folder but link to two docs) > - How-to articles (1 guide) > - Community (guide on apache-related processes) > - Data IO (designs) > - Continuous Integration (guides, designs) > - Meetups and Hangouts (events) > > And here are two good examples from successful Apache projects: > - Apache Flink: an **audience-oriented** structure [1] > Users (Presentations and How-to) > Contributors (Dev processes and How-to) > Committers (Infra, Dev processes, Release processes, Releases) > Roadmaps and Feature Designs (archive) > - Apache OpenNLP: a **content-oriented** structure [2] > Guides > External Resources > Proposals > Releasing > > Clean organization helps content discovery and saves time on locating useful > content. Given that we have good amount of content on the wiki page, I > suggest that we decide on a cleaner taxonomy, re-organize contents > accordingly, and add future contents accordingly. To provide a starting point > for the discussion, I suggest: > - Given the state we are in, start with content-oriented organization, use > these top-level categories: Guides (including processes and how-tos), > Development (including designs, proposals, notes, roadmaps), Community > (including events, activities, external resources and contents) > - If people strongly prefer audience-oriented structure, later we can adopt a > structure similar to Flink's. > > Feel free to share your thoughts and preferences here. Thanks. > > -sz > > [1] > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttp > s://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index
Re: Taxonomy on our cwiki
When the home page was renamed to apache-mxnet from just MXNet it said the page no longer existed, so we should verify anything in the website and update accordingly. On Fri, Jan 18, 2019, 17:20 Haibin Lin +1 > > Will there be broken links? I thought confluence will show "page is now > moved to https://xxx.html; to redirect users, when this kind of reorg > happens. > > Best, > Haibin > > On Fri, Jan 18, 2019 at 4:50 PM Aaron Markham > wrote: > > > +1 but note that this is probably going to create a bunch of broken links > > on the MXNet website and maybe elsewhere. Should make time to deal with > > that in this process. > > > > On Fri, Jan 18, 2019, 12:43 Carin Meier > > > > +1 Great idea > > > > > > On Fri, Jan 18, 2019 at 2:38 PM Sheng Zha wrote: > > > > > > > Hi MXNet, > > > > > > > > Given that currently cwiki is the only place other than mxnet website > > for > > > > mxnet-related documentation, I'd like to request your attention to > the > > > > (slightly disorganized) cwiki page of MXNet. The top level folders > (and > > > > their contents) currently looks like this: > > > > - Design Proposals* (bag of proposals, not in order) > > > > - Development* (mixture of guides, roadmaps, processes) > > > > - Release Process (release notes) > > > > - Website (guides and proposals) > > > > - MXNet Clojure (call for contribution, guides) > > > > - MXNet Keras Integration (design) > > > > - MXNet-ONNX Integration (design, dev status) > > > > - MXNet R Package (guide, backlog) > > > > - MXNet-Scala (design, dev status, guide) > > > > - Content Formatting Templates (not a folder but link to two docs) > > > > - How-to articles (1 guide) > > > > - Community (guide on apache-related processes) > > > > - Data IO (designs) > > > > - Continuous Integration (guides, designs) > > > > - Meetups and Hangouts (events) > > > > > > > > And here are two good examples from successful Apache projects: > > > > - Apache Flink: an **audience-oriented** structure [1] > > > > Users (Presentations and How-to) > > > > Contributors (Dev processes and How-to) > > > > Committers (Infra, Dev processes, Release processes, Releases) > > > > Roadmaps and Feature Designs (archive) > > > > - Apache OpenNLP: a **content-oriented** structure [2] > > > > Guides > > > > External Resources > > > > Proposals > > > > Releasing > > > > > > > > Clean organization helps content discovery and saves time on locating > > > > useful content. Given that we have good amount of content on the wiki > > > page, > > > > I suggest that we decide on a cleaner taxonomy, re-organize contents > > > > accordingly, and add future contents accordingly. To provide a > starting > > > > point for the discussion, I suggest: > > > > - Given the state we are in, start with content-oriented > organization, > > > use > > > > these top-level categories: Guides (including processes and how-tos), > > > > Development (including designs, proposals, notes, roadmaps), > Community > > > > (including events, activities, external resources and contents) > > > > - If people strongly prefer audience-oriented structure, later we can > > > adopt > > > > a structure similar to Flink's. > > > > > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > > > > > -sz > > > > > > > > [1] > > > > > > > > > > > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttps://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index > > > > > > > > > >
Re: Taxonomy on our cwiki
+1 Will there be broken links? I thought confluence will show "page is now moved to https://xxx.html; to redirect users, when this kind of reorg happens. Best, Haibin On Fri, Jan 18, 2019 at 4:50 PM Aaron Markham wrote: > +1 but note that this is probably going to create a bunch of broken links > on the MXNet website and maybe elsewhere. Should make time to deal with > that in this process. > > On Fri, Jan 18, 2019, 12:43 Carin Meier > > +1 Great idea > > > > On Fri, Jan 18, 2019 at 2:38 PM Sheng Zha wrote: > > > > > Hi MXNet, > > > > > > Given that currently cwiki is the only place other than mxnet website > for > > > mxnet-related documentation, I'd like to request your attention to the > > > (slightly disorganized) cwiki page of MXNet. The top level folders (and > > > their contents) currently looks like this: > > > - Design Proposals* (bag of proposals, not in order) > > > - Development* (mixture of guides, roadmaps, processes) > > > - Release Process (release notes) > > > - Website (guides and proposals) > > > - MXNet Clojure (call for contribution, guides) > > > - MXNet Keras Integration (design) > > > - MXNet-ONNX Integration (design, dev status) > > > - MXNet R Package (guide, backlog) > > > - MXNet-Scala (design, dev status, guide) > > > - Content Formatting Templates (not a folder but link to two docs) > > > - How-to articles (1 guide) > > > - Community (guide on apache-related processes) > > > - Data IO (designs) > > > - Continuous Integration (guides, designs) > > > - Meetups and Hangouts (events) > > > > > > And here are two good examples from successful Apache projects: > > > - Apache Flink: an **audience-oriented** structure [1] > > > Users (Presentations and How-to) > > > Contributors (Dev processes and How-to) > > > Committers (Infra, Dev processes, Release processes, Releases) > > > Roadmaps and Feature Designs (archive) > > > - Apache OpenNLP: a **content-oriented** structure [2] > > > Guides > > > External Resources > > > Proposals > > > Releasing > > > > > > Clean organization helps content discovery and saves time on locating > > > useful content. Given that we have good amount of content on the wiki > > page, > > > I suggest that we decide on a cleaner taxonomy, re-organize contents > > > accordingly, and add future contents accordingly. To provide a starting > > > point for the discussion, I suggest: > > > - Given the state we are in, start with content-oriented organization, > > use > > > these top-level categories: Guides (including processes and how-tos), > > > Development (including designs, proposals, notes, roadmaps), Community > > > (including events, activities, external resources and contents) > > > - If people strongly prefer audience-oriented structure, later we can > > adopt > > > a structure similar to Flink's. > > > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > > > -sz > > > > > > [1] > > > > > > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttps://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index > > > > > >
Re: Taxonomy on our cwiki
+1 but note that this is probably going to create a bunch of broken links on the MXNet website and maybe elsewhere. Should make time to deal with that in this process. On Fri, Jan 18, 2019, 12:43 Carin Meier +1 Great idea > > On Fri, Jan 18, 2019 at 2:38 PM Sheng Zha wrote: > > > Hi MXNet, > > > > Given that currently cwiki is the only place other than mxnet website for > > mxnet-related documentation, I'd like to request your attention to the > > (slightly disorganized) cwiki page of MXNet. The top level folders (and > > their contents) currently looks like this: > > - Design Proposals* (bag of proposals, not in order) > > - Development* (mixture of guides, roadmaps, processes) > > - Release Process (release notes) > > - Website (guides and proposals) > > - MXNet Clojure (call for contribution, guides) > > - MXNet Keras Integration (design) > > - MXNet-ONNX Integration (design, dev status) > > - MXNet R Package (guide, backlog) > > - MXNet-Scala (design, dev status, guide) > > - Content Formatting Templates (not a folder but link to two docs) > > - How-to articles (1 guide) > > - Community (guide on apache-related processes) > > - Data IO (designs) > > - Continuous Integration (guides, designs) > > - Meetups and Hangouts (events) > > > > And here are two good examples from successful Apache projects: > > - Apache Flink: an **audience-oriented** structure [1] > > Users (Presentations and How-to) > > Contributors (Dev processes and How-to) > > Committers (Infra, Dev processes, Release processes, Releases) > > Roadmaps and Feature Designs (archive) > > - Apache OpenNLP: a **content-oriented** structure [2] > > Guides > > External Resources > > Proposals > > Releasing > > > > Clean organization helps content discovery and saves time on locating > > useful content. Given that we have good amount of content on the wiki > page, > > I suggest that we decide on a cleaner taxonomy, re-organize contents > > accordingly, and add future contents accordingly. To provide a starting > > point for the discussion, I suggest: > > - Given the state we are in, start with content-oriented organization, > use > > these top-level categories: Guides (including processes and how-tos), > > Development (including designs, proposals, notes, roadmaps), Community > > (including events, activities, external resources and contents) > > - If people strongly prefer audience-oriented structure, later we can > adopt > > a structure similar to Flink's. > > > > Feel free to share your thoughts and preferences here. Thanks. > > > > -sz > > > > [1] > > > > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttps://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index > > >
Re: Taxonomy on our cwiki
+1 Great idea On Fri, Jan 18, 2019 at 2:38 PM Sheng Zha wrote: > Hi MXNet, > > Given that currently cwiki is the only place other than mxnet website for > mxnet-related documentation, I'd like to request your attention to the > (slightly disorganized) cwiki page of MXNet. The top level folders (and > their contents) currently looks like this: > - Design Proposals* (bag of proposals, not in order) > - Development* (mixture of guides, roadmaps, processes) > - Release Process (release notes) > - Website (guides and proposals) > - MXNet Clojure (call for contribution, guides) > - MXNet Keras Integration (design) > - MXNet-ONNX Integration (design, dev status) > - MXNet R Package (guide, backlog) > - MXNet-Scala (design, dev status, guide) > - Content Formatting Templates (not a folder but link to two docs) > - How-to articles (1 guide) > - Community (guide on apache-related processes) > - Data IO (designs) > - Continuous Integration (guides, designs) > - Meetups and Hangouts (events) > > And here are two good examples from successful Apache projects: > - Apache Flink: an **audience-oriented** structure [1] > Users (Presentations and How-to) > Contributors (Dev processes and How-to) > Committers (Infra, Dev processes, Release processes, Releases) > Roadmaps and Feature Designs (archive) > - Apache OpenNLP: a **content-oriented** structure [2] > Guides > External Resources > Proposals > Releasing > > Clean organization helps content discovery and saves time on locating > useful content. Given that we have good amount of content on the wiki page, > I suggest that we decide on a cleaner taxonomy, re-organize contents > accordingly, and add future contents accordingly. To provide a starting > point for the discussion, I suggest: > - Given the state we are in, start with content-oriented organization, use > these top-level categories: Guides (including processes and how-tos), > Development (including designs, proposals, notes, roadmaps), Community > (including events, activities, external resources and contents) > - If people strongly prefer audience-oriented structure, later we can adopt > a structure similar to Flink's. > > Feel free to share your thoughts and preferences here. Thanks. > > -sz > > [1] > > https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttps://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home > [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index >
Taxonomy on our cwiki
Hi MXNet, Given that currently cwiki is the only place other than mxnet website for mxnet-related documentation, I'd like to request your attention to the (slightly disorganized) cwiki page of MXNet. The top level folders (and their contents) currently looks like this: - Design Proposals* (bag of proposals, not in order) - Development* (mixture of guides, roadmaps, processes) - Release Process (release notes) - Website (guides and proposals) - MXNet Clojure (call for contribution, guides) - MXNet Keras Integration (design) - MXNet-ONNX Integration (design, dev status) - MXNet R Package (guide, backlog) - MXNet-Scala (design, dev status, guide) - Content Formatting Templates (not a folder but link to two docs) - How-to articles (1 guide) - Community (guide on apache-related processes) - Data IO (designs) - Continuous Integration (guides, designs) - Meetups and Hangouts (events) And here are two good examples from successful Apache projects: - Apache Flink: an **audience-oriented** structure [1] Users (Presentations and How-to) Contributors (Dev processes and How-to) Committers (Infra, Dev processes, Release processes, Releases) Roadmaps and Feature Designs (archive) - Apache OpenNLP: a **content-oriented** structure [2] Guides External Resources Proposals Releasing Clean organization helps content discovery and saves time on locating useful content. Given that we have good amount of content on the wiki page, I suggest that we decide on a cleaner taxonomy, re-organize contents accordingly, and add future contents accordingly. To provide a starting point for the discussion, I suggest: - Given the state we are in, start with content-oriented organization, use these top-level categories: Guides (including processes and how-tos), Development (including designs, proposals, notes, roadmaps), Community (including events, activities, external resources and contents) - If people strongly prefer audience-oriented structure, later we can adopt a structure similar to Flink's. Feel free to share your thoughts and preferences here. Thanks. -sz [1] https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Homehttps://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home [2] https://cwiki.apache.org/confluence/display/OPENNLP/Index
