You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mxnet.apache.org by Aaron Markham <aa...@gmail.com> on 2018/09/04 20:46:01 UTC
Re: [LAZY VOTE] Consolidating developer guide in one place (cwiki preferred)
I'd like to call for a lazy vote on this before proceeding. Already had
some +1s but let's be sure.
The vote is to move developer guide info to cwiki. User guides would remain
on the website.
On Tue, Aug 21, 2018 at 12:53 PM sandeep krishnamurthy <
sandeep.krishna98@gmail.com> wrote:
> +1
> Thanks Lin and Aaron. I agree website to cover all user facing
> documentation and a separate consolidated and organized developer focussed
> docs in one place (cwiki).
>
>
> Note: Permissions on cwiki is currently not well managed with many people
> having full admin rights to edit/create/delete pages. Should be fine for
> now, but, when we start accumulating many documents and resources, we
> should probably revisit on Delete permissions.
>
>
> On Tue, Aug 21, 2018 at 11:57 AM Lin Yuan <ap...@gmail.com> wrote:
>
> > Hi Aaron,
> >
> > Thanks for your answer. I think it's a very worthwhile effort to move all
> > the developer related content from mxet.io website to a dedicated
> > developer
> > site. Would you like to initiate this effort?
> >
> > Best,
> >
> > Lin
> >
> > On Wed, Aug 15, 2018 at 3:47 PM Haibin Lin <ha...@gmail.com>
> > wrote:
> >
> > > +1
> > >
> > > On Wed, Aug 15, 2018 at 1:10 PM, Aaron Markham <
> > aaron.s.markham@gmail.com>
> > > wrote:
> > >
> > > > Hi Lin, I agree with this organization. If you feel like somethings
> > > should
> > > > be transitioned from the website to the wiki, I can help with that,
> but
> > > for
> > > > the moment I've been suggesting that new developer-focused content be
> > > > placed on the wiki.
> > > >
> > > > On Tue, Aug 14, 2018 at 10:40 AM, Lin Yuan <ap...@gmail.com>
> > wrote:
> > > >
> > > > > Dear MXNet community,
> > > > >
> > > > > As a developer, I noticed we have some developer guide scattered in
> > > > > different websites (mxnet.io, cwiki):
> > > > >
> > > > > E.g.
> > > > >
> > > > > How to Create New Operators (Layers): [
> > > > > https://mxnet.incubator.apache.org/faq/new_op.html]
> > > > > A Guide to Implementing Sparse Operators in MXNet Backend [
> > > > > https://cwiki.apache.org/confluence/display/MXNET/A+
> > > > > Guide+to+Implementing+Sparse+Operators+in+MXNet+Backend
> > > > > ]
> > > > >
> > > > > When searching developer guide by keyword, only one of them can be
> > > > returned
> > > > > on either site.
> > > > >
> > > > > It will be more convenient for developers if all the developer
> guide
> > > > > resides on cwiki and all user guide (non-developer) on the
> mxnet.io
> > > > > website. We can add a link on mxnet.io to refer all developers to
> > > cwiki
> > > > > for
> > > > > guidance.
> > > > >
> > > > > Any comment is appreciated.
> > > > >
> > > > > Best Regards,
> > > > >
> > > > > Lin
> > > > >
> > > >
> > >
> >
>
>
> --
> Sandeep Krishnamurthy
>
Re: [LAZY VOTE] Consolidating developer guide in one place (cwiki preferred)
Posted by Lin Yuan <ap...@gmail.com>.
Hi Aaron,
Thanks a lot for effort. This consolidation will make it more convenient
for developers to find development resource and help to attract more
contributors.
I have also created a story to make it easy for developers to navigate from
mxnet.io: https://issues.apache.org/jira/browse/MXNET-1002
Thanks!
Lin
On Wed, Sep 26, 2018 at 10:24 AM Aaron Markham <aa...@gmail.com>
wrote:
> I think the latest feedback has been great. It seems to be mostly user
> level issues though. Installation and usage primarily, with a sprinkle of
> *if that stuff was better then I might be able to contribute*.
>
> I've (with a few other contributors) tackled some of the very direct bits
> of feedback for the website by incremental improvement of the install
> pages, Gluon info, and UX for the API docs.
>
> I've started additional planning for updates by adding an epic with
> specific stories and tasks to Jira for the documentation pipeline (the
> backend part of the website build):
> https://issues.apache.org/jira/browse/MXNET-957
>
> I've also added one that is more specific to the website's content:
> https://issues.apache.org/jira/browse/MXNET-986
> This is where I've captured only two tasks related to transitioning content
> related to "contributing to MXNet" over to the wiki. Any pointers on which
> content to move would help. These could be added as tasks too.
>
> I welcome any suggestions, additions, and contributions to either of these
> epics.
>
> Cheers,
> Aaron
>
> On Wed, Sep 26, 2018, 00:02 Lin Yuan <ap...@gmail.com> wrote:
>
> > Hi Aaron,
> >
> > Do we have a resolution for this proposal yet? Recently, there have been
> > many asks for a better documentation for MXNet developers. I think it's a
> > good time that we consolidate the developer documentation in a central
> > place. Any thoughts or plan?
> >
> > Many Thanks,
> >
> > Lin
> >
> > On Tue, Sep 4, 2018 at 1:55 PM Lin Yuan <ap...@gmail.com> wrote:
> >
> > > +1
> > >
> > > On Tue, Sep 4, 2018 at 1:46 PM Aaron Markham <
> aaron.s.markham@gmail.com>
> > > wrote:
> > >
> > >> I'd like to call for a lazy vote on this before proceeding. Already
> had
> > >> some +1s but let's be sure.
> > >>
> > >> The vote is to move developer guide info to cwiki. User guides would
> > >> remain
> > >> on the website.
> > >>
> > >> On Tue, Aug 21, 2018 at 12:53 PM sandeep krishnamurthy <
> > >> sandeep.krishna98@gmail.com> wrote:
> > >>
> > >> > +1
> > >> > Thanks Lin and Aaron. I agree website to cover all user facing
> > >> > documentation and a separate consolidated and organized developer
> > >> focussed
> > >> > docs in one place (cwiki).
> > >> >
> > >> >
> > >> > Note: Permissions on cwiki is currently not well managed with many
> > >> people
> > >> > having full admin rights to edit/create/delete pages. Should be fine
> > for
> > >> > now, but, when we start accumulating many documents and resources,
> we
> > >> > should probably revisit on Delete permissions.
> > >> >
> > >> >
> > >> > On Tue, Aug 21, 2018 at 11:57 AM Lin Yuan <ap...@gmail.com>
> > wrote:
> > >> >
> > >> > > Hi Aaron,
> > >> > >
> > >> > > Thanks for your answer. I think it's a very worthwhile effort to
> > move
> > >> all
> > >> > > the developer related content from mxet.io website to a dedicated
> > >> > > developer
> > >> > > site. Would you like to initiate this effort?
> > >> > >
> > >> > > Best,
> > >> > >
> > >> > > Lin
> > >> > >
> > >> > > On Wed, Aug 15, 2018 at 3:47 PM Haibin Lin <
> > haibin.lin.aws@gmail.com>
> > >> > > wrote:
> > >> > >
> > >> > > > +1
> > >> > > >
> > >> > > > On Wed, Aug 15, 2018 at 1:10 PM, Aaron Markham <
> > >> > > aaron.s.markham@gmail.com>
> > >> > > > wrote:
> > >> > > >
> > >> > > > > Hi Lin, I agree with this organization. If you feel like
> > >> somethings
> > >> > > > should
> > >> > > > > be transitioned from the website to the wiki, I can help with
> > >> that,
> > >> > but
> > >> > > > for
> > >> > > > > the moment I've been suggesting that new developer-focused
> > >> content be
> > >> > > > > placed on the wiki.
> > >> > > > >
> > >> > > > > On Tue, Aug 14, 2018 at 10:40 AM, Lin Yuan <
> apeforest@gmail.com
> > >
> > >> > > wrote:
> > >> > > > >
> > >> > > > > > Dear MXNet community,
> > >> > > > > >
> > >> > > > > > As a developer, I noticed we have some developer guide
> > >> scattered in
> > >> > > > > > different websites (mxnet.io, cwiki):
> > >> > > > > >
> > >> > > > > > E.g.
> > >> > > > > >
> > >> > > > > > How to Create New Operators (Layers): [
> > >> > > > > > https://mxnet.incubator.apache.org/faq/new_op.html]
> > >> > > > > > A Guide to Implementing Sparse Operators in MXNet Backend [
> > >> > > > > > https://cwiki.apache.org/confluence/display/MXNET/A+
> > >> > > > > > Guide+to+Implementing+Sparse+Operators+in+MXNet+Backend
> > >> > > > > > ]
> > >> > > > > >
> > >> > > > > > When searching developer guide by keyword, only one of them
> > can
> > >> be
> > >> > > > > returned
> > >> > > > > > on either site.
> > >> > > > > >
> > >> > > > > > It will be more convenient for developers if all the
> developer
> > >> > guide
> > >> > > > > > resides on cwiki and all user guide (non-developer) on the
> > >> > mxnet.io
> > >> > > > > > website. We can add a link on mxnet.io to refer all
> > developers
> > >> to
> > >> > > > cwiki
> > >> > > > > > for
> > >> > > > > > guidance.
> > >> > > > > >
> > >> > > > > > Any comment is appreciated.
> > >> > > > > >
> > >> > > > > > Best Regards,
> > >> > > > > >
> > >> > > > > > Lin
> > >> > > > > >
> > >> > > > >
> > >> > > >
> > >> > >
> > >> >
> > >> >
> > >> > --
> > >> > Sandeep Krishnamurthy
> > >> >
> > >>
> > >
> >
>
Re: [LAZY VOTE] Consolidating developer guide in one place (cwiki preferred)
Posted by Aaron Markham <aa...@gmail.com>.
I think the latest feedback has been great. It seems to be mostly user
level issues though. Installation and usage primarily, with a sprinkle of
*if that stuff was better then I might be able to contribute*.
I've (with a few other contributors) tackled some of the very direct bits
of feedback for the website by incremental improvement of the install
pages, Gluon info, and UX for the API docs.
I've started additional planning for updates by adding an epic with
specific stories and tasks to Jira for the documentation pipeline (the
backend part of the website build):
https://issues.apache.org/jira/browse/MXNET-957
I've also added one that is more specific to the website's content:
https://issues.apache.org/jira/browse/MXNET-986
This is where I've captured only two tasks related to transitioning content
related to "contributing to MXNet" over to the wiki. Any pointers on which
content to move would help. These could be added as tasks too.
I welcome any suggestions, additions, and contributions to either of these
epics.
Cheers,
Aaron
On Wed, Sep 26, 2018, 00:02 Lin Yuan <ap...@gmail.com> wrote:
> Hi Aaron,
>
> Do we have a resolution for this proposal yet? Recently, there have been
> many asks for a better documentation for MXNet developers. I think it's a
> good time that we consolidate the developer documentation in a central
> place. Any thoughts or plan?
>
> Many Thanks,
>
> Lin
>
> On Tue, Sep 4, 2018 at 1:55 PM Lin Yuan <ap...@gmail.com> wrote:
>
> > +1
> >
> > On Tue, Sep 4, 2018 at 1:46 PM Aaron Markham <aa...@gmail.com>
> > wrote:
> >
> >> I'd like to call for a lazy vote on this before proceeding. Already had
> >> some +1s but let's be sure.
> >>
> >> The vote is to move developer guide info to cwiki. User guides would
> >> remain
> >> on the website.
> >>
> >> On Tue, Aug 21, 2018 at 12:53 PM sandeep krishnamurthy <
> >> sandeep.krishna98@gmail.com> wrote:
> >>
> >> > +1
> >> > Thanks Lin and Aaron. I agree website to cover all user facing
> >> > documentation and a separate consolidated and organized developer
> >> focussed
> >> > docs in one place (cwiki).
> >> >
> >> >
> >> > Note: Permissions on cwiki is currently not well managed with many
> >> people
> >> > having full admin rights to edit/create/delete pages. Should be fine
> for
> >> > now, but, when we start accumulating many documents and resources, we
> >> > should probably revisit on Delete permissions.
> >> >
> >> >
> >> > On Tue, Aug 21, 2018 at 11:57 AM Lin Yuan <ap...@gmail.com>
> wrote:
> >> >
> >> > > Hi Aaron,
> >> > >
> >> > > Thanks for your answer. I think it's a very worthwhile effort to
> move
> >> all
> >> > > the developer related content from mxet.io website to a dedicated
> >> > > developer
> >> > > site. Would you like to initiate this effort?
> >> > >
> >> > > Best,
> >> > >
> >> > > Lin
> >> > >
> >> > > On Wed, Aug 15, 2018 at 3:47 PM Haibin Lin <
> haibin.lin.aws@gmail.com>
> >> > > wrote:
> >> > >
> >> > > > +1
> >> > > >
> >> > > > On Wed, Aug 15, 2018 at 1:10 PM, Aaron Markham <
> >> > > aaron.s.markham@gmail.com>
> >> > > > wrote:
> >> > > >
> >> > > > > Hi Lin, I agree with this organization. If you feel like
> >> somethings
> >> > > > should
> >> > > > > be transitioned from the website to the wiki, I can help with
> >> that,
> >> > but
> >> > > > for
> >> > > > > the moment I've been suggesting that new developer-focused
> >> content be
> >> > > > > placed on the wiki.
> >> > > > >
> >> > > > > On Tue, Aug 14, 2018 at 10:40 AM, Lin Yuan <apeforest@gmail.com
> >
> >> > > wrote:
> >> > > > >
> >> > > > > > Dear MXNet community,
> >> > > > > >
> >> > > > > > As a developer, I noticed we have some developer guide
> >> scattered in
> >> > > > > > different websites (mxnet.io, cwiki):
> >> > > > > >
> >> > > > > > E.g.
> >> > > > > >
> >> > > > > > How to Create New Operators (Layers): [
> >> > > > > > https://mxnet.incubator.apache.org/faq/new_op.html]
> >> > > > > > A Guide to Implementing Sparse Operators in MXNet Backend [
> >> > > > > > https://cwiki.apache.org/confluence/display/MXNET/A+
> >> > > > > > Guide+to+Implementing+Sparse+Operators+in+MXNet+Backend
> >> > > > > > ]
> >> > > > > >
> >> > > > > > When searching developer guide by keyword, only one of them
> can
> >> be
> >> > > > > returned
> >> > > > > > on either site.
> >> > > > > >
> >> > > > > > It will be more convenient for developers if all the developer
> >> > guide
> >> > > > > > resides on cwiki and all user guide (non-developer) on the
> >> > mxnet.io
> >> > > > > > website. We can add a link on mxnet.io to refer all
> developers
> >> to
> >> > > > cwiki
> >> > > > > > for
> >> > > > > > guidance.
> >> > > > > >
> >> > > > > > Any comment is appreciated.
> >> > > > > >
> >> > > > > > Best Regards,
> >> > > > > >
> >> > > > > > Lin
> >> > > > > >
> >> > > > >
> >> > > >
> >> > >
> >> >
> >> >
> >> > --
> >> > Sandeep Krishnamurthy
> >> >
> >>
> >
>
Re: [LAZY VOTE] Consolidating developer guide in one place (cwiki preferred)
Posted by Lin Yuan <ap...@gmail.com>.
Hi Aaron,
Do we have a resolution for this proposal yet? Recently, there have been
many asks for a better documentation for MXNet developers. I think it's a
good time that we consolidate the developer documentation in a central
place. Any thoughts or plan?
Many Thanks,
Lin
On Tue, Sep 4, 2018 at 1:55 PM Lin Yuan <ap...@gmail.com> wrote:
> +1
>
> On Tue, Sep 4, 2018 at 1:46 PM Aaron Markham <aa...@gmail.com>
> wrote:
>
>> I'd like to call for a lazy vote on this before proceeding. Already had
>> some +1s but let's be sure.
>>
>> The vote is to move developer guide info to cwiki. User guides would
>> remain
>> on the website.
>>
>> On Tue, Aug 21, 2018 at 12:53 PM sandeep krishnamurthy <
>> sandeep.krishna98@gmail.com> wrote:
>>
>> > +1
>> > Thanks Lin and Aaron. I agree website to cover all user facing
>> > documentation and a separate consolidated and organized developer
>> focussed
>> > docs in one place (cwiki).
>> >
>> >
>> > Note: Permissions on cwiki is currently not well managed with many
>> people
>> > having full admin rights to edit/create/delete pages. Should be fine for
>> > now, but, when we start accumulating many documents and resources, we
>> > should probably revisit on Delete permissions.
>> >
>> >
>> > On Tue, Aug 21, 2018 at 11:57 AM Lin Yuan <ap...@gmail.com> wrote:
>> >
>> > > Hi Aaron,
>> > >
>> > > Thanks for your answer. I think it's a very worthwhile effort to move
>> all
>> > > the developer related content from mxet.io website to a dedicated
>> > > developer
>> > > site. Would you like to initiate this effort?
>> > >
>> > > Best,
>> > >
>> > > Lin
>> > >
>> > > On Wed, Aug 15, 2018 at 3:47 PM Haibin Lin <ha...@gmail.com>
>> > > wrote:
>> > >
>> > > > +1
>> > > >
>> > > > On Wed, Aug 15, 2018 at 1:10 PM, Aaron Markham <
>> > > aaron.s.markham@gmail.com>
>> > > > wrote:
>> > > >
>> > > > > Hi Lin, I agree with this organization. If you feel like
>> somethings
>> > > > should
>> > > > > be transitioned from the website to the wiki, I can help with
>> that,
>> > but
>> > > > for
>> > > > > the moment I've been suggesting that new developer-focused
>> content be
>> > > > > placed on the wiki.
>> > > > >
>> > > > > On Tue, Aug 14, 2018 at 10:40 AM, Lin Yuan <ap...@gmail.com>
>> > > wrote:
>> > > > >
>> > > > > > Dear MXNet community,
>> > > > > >
>> > > > > > As a developer, I noticed we have some developer guide
>> scattered in
>> > > > > > different websites (mxnet.io, cwiki):
>> > > > > >
>> > > > > > E.g.
>> > > > > >
>> > > > > > How to Create New Operators (Layers): [
>> > > > > > https://mxnet.incubator.apache.org/faq/new_op.html]
>> > > > > > A Guide to Implementing Sparse Operators in MXNet Backend [
>> > > > > > https://cwiki.apache.org/confluence/display/MXNET/A+
>> > > > > > Guide+to+Implementing+Sparse+Operators+in+MXNet+Backend
>> > > > > > ]
>> > > > > >
>> > > > > > When searching developer guide by keyword, only one of them can
>> be
>> > > > > returned
>> > > > > > on either site.
>> > > > > >
>> > > > > > It will be more convenient for developers if all the developer
>> > guide
>> > > > > > resides on cwiki and all user guide (non-developer) on the
>> > mxnet.io
>> > > > > > website. We can add a link on mxnet.io to refer all developers
>> to
>> > > > cwiki
>> > > > > > for
>> > > > > > guidance.
>> > > > > >
>> > > > > > Any comment is appreciated.
>> > > > > >
>> > > > > > Best Regards,
>> > > > > >
>> > > > > > Lin
>> > > > > >
>> > > > >
>> > > >
>> > >
>> >
>> >
>> > --
>> > Sandeep Krishnamurthy
>> >
>>
>
Re: [LAZY VOTE] Consolidating developer guide in one place (cwiki preferred)
Posted by Lin Yuan <ap...@gmail.com>.
+1
On Tue, Sep 4, 2018 at 1:46 PM Aaron Markham <aa...@gmail.com>
wrote:
> I'd like to call for a lazy vote on this before proceeding. Already had
> some +1s but let's be sure.
>
> The vote is to move developer guide info to cwiki. User guides would remain
> on the website.
>
> On Tue, Aug 21, 2018 at 12:53 PM sandeep krishnamurthy <
> sandeep.krishna98@gmail.com> wrote:
>
> > +1
> > Thanks Lin and Aaron. I agree website to cover all user facing
> > documentation and a separate consolidated and organized developer
> focussed
> > docs in one place (cwiki).
> >
> >
> > Note: Permissions on cwiki is currently not well managed with many people
> > having full admin rights to edit/create/delete pages. Should be fine for
> > now, but, when we start accumulating many documents and resources, we
> > should probably revisit on Delete permissions.
> >
> >
> > On Tue, Aug 21, 2018 at 11:57 AM Lin Yuan <ap...@gmail.com> wrote:
> >
> > > Hi Aaron,
> > >
> > > Thanks for your answer. I think it's a very worthwhile effort to move
> all
> > > the developer related content from mxet.io website to a dedicated
> > > developer
> > > site. Would you like to initiate this effort?
> > >
> > > Best,
> > >
> > > Lin
> > >
> > > On Wed, Aug 15, 2018 at 3:47 PM Haibin Lin <ha...@gmail.com>
> > > wrote:
> > >
> > > > +1
> > > >
> > > > On Wed, Aug 15, 2018 at 1:10 PM, Aaron Markham <
> > > aaron.s.markham@gmail.com>
> > > > wrote:
> > > >
> > > > > Hi Lin, I agree with this organization. If you feel like somethings
> > > > should
> > > > > be transitioned from the website to the wiki, I can help with that,
> > but
> > > > for
> > > > > the moment I've been suggesting that new developer-focused content
> be
> > > > > placed on the wiki.
> > > > >
> > > > > On Tue, Aug 14, 2018 at 10:40 AM, Lin Yuan <ap...@gmail.com>
> > > wrote:
> > > > >
> > > > > > Dear MXNet community,
> > > > > >
> > > > > > As a developer, I noticed we have some developer guide scattered
> in
> > > > > > different websites (mxnet.io, cwiki):
> > > > > >
> > > > > > E.g.
> > > > > >
> > > > > > How to Create New Operators (Layers): [
> > > > > > https://mxnet.incubator.apache.org/faq/new_op.html]
> > > > > > A Guide to Implementing Sparse Operators in MXNet Backend [
> > > > > > https://cwiki.apache.org/confluence/display/MXNET/A+
> > > > > > Guide+to+Implementing+Sparse+Operators+in+MXNet+Backend
> > > > > > ]
> > > > > >
> > > > > > When searching developer guide by keyword, only one of them can
> be
> > > > > returned
> > > > > > on either site.
> > > > > >
> > > > > > It will be more convenient for developers if all the developer
> > guide
> > > > > > resides on cwiki and all user guide (non-developer) on the
> > mxnet.io
> > > > > > website. We can add a link on mxnet.io to refer all developers
> to
> > > > cwiki
> > > > > > for
> > > > > > guidance.
> > > > > >
> > > > > > Any comment is appreciated.
> > > > > >
> > > > > > Best Regards,
> > > > > >
> > > > > > Lin
> > > > > >
> > > > >
> > > >
> > >
> >
> >
> > --
> > Sandeep Krishnamurthy
> >
>