You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mxnet.apache.org by Joe Evans <jo...@gmail.com> on 2021/02/16 02:33:32 UTC
[Proposal] Change to release process
Hi dev community,
Currently, when MXNet creates a new release, we manually create the source
archives using commands in the release runbook here:
https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
Based on feedback from Apache, there are a few non-Apache 2.0 licenses
files that we should not distribute in the source archives, or explicitly
call them out in the LICENSE file. The following files were identified as
non-AL2:
3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
3rdparty/mkldnn/doc/assets/fonts/lato*
3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
I believe we can simply remove the entire 3rdparty/mkldnn/doc/assets
directory for mkldnn and not include it in our source archive. The
mxtheme has already been removed from the source tree (and replaced by
doing a pip install of the mx-theme package instead) by @szha.
I propose we automate this step of the release runbook by creating a script
in the repo that checks out the passed tag, removes any problematic files
that we can not distribute, and perform a apache-rat license check to
ensure our source archive is compliant. Does anyone have any input or
suggestions?
Thanks,
Joe
Re: [Proposal] Change to release process
Posted by Aaron Markham <aa...@gmail.com>.
Sheng,
Here's one where the footer and the right side menus were overlapping:
https://github.com/apache/incubator-mxnet/pull/18863
More UX fixes:
https://github.com/apache/incubator-mxnet/pull/18845
The feedback widget was customized:
https://github.com/apache/incubator-mxnet/pull/18639
The above were driven mostly by Yang Shi and Connor Goggins before him.
They'd recall even more, but we can see in the edit history of the files.
When we first launched the new site & CI flow, Thomas Delteil might have
made additional edits, but I'm thinking these can be captured by looking at
what's in the folder and seeing that these html files are customized:
https://github.com/apache/incubator-mxnet/tree/master/docs/python_docs/themes/mx-theme/mxtheme
Ideally the theme would support Sphinx configs like "html_theme_options"
where we could point to custom html files, but this isn't documented in the
mxtheme package. There are some config options set in conf.py, so I'm
inclined to believe it would.
All said, there's a lot of work to be done just to deal with font licenses.
Why not just swap out the fonts?
On Tue, Feb 16, 2021 at 1:19 PM sandeep krishnamurthy <
sandeep.krishna98@gmail.com> wrote:
> Thanks Joe.
> Automated script to prepare source tar which are compliant with Apache
> license and also a list of excluded files in one place greatly helps in
> preparing MXNet releases quickly and helps voters to easily validate
> compliance checks.
>
> Is this list a complete list of files that needs to be ignored, or may this
> list expand as we run RAT license checks on 3rd party modules?
>
> 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> 3rdparty/mkldnn/doc/assets/fonts/lato*
> 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
>
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
>
> Thanks a lot for this contribution.
>
> Thanks,
> Sandeep
>
> On Tue, Feb 16, 2021 at 9:34 AM Sheng Zha <zh...@apache.org> wrote:
>
> > Thanks for bringing this up. If you have specific issues to share I would
> > really appreciate it.
> >
> > On 2021/02/16 16:39:41, Aaron Markham <aa...@gmail.com> wrote:
> > > Some folks use the docs build to make offline docs. Really need to make
> > > sure those build properly from the release once you make that change
> with
> > > mxtheme. There were a variety of patches going on with the local
> version
> > of
> > > it...IIRC... None of the bugs were being addressed at the time in the
> > > mxtheme package level so that's why it was brought in locally and
> > modified.
> > > I'm guessing a pip install might appear to work, but then you're
> probably
> > > going to find some display problems in the python docs. The folks that
> > > worked on the front end code for the website would likely recall these
> > > issues. If you make the change for how the site is built now then at
> > least
> > > it will break for everyone and it can be addressed in a way that can
> deal
> > > with these license issues.
> > >
> > > On Tue, Feb 16, 2021, 1:41 AM Marco de Abreu <ma...@gmail.com>
> > > wrote:
> > >
> > > > +1 definitely a good idea to create consistent releases
> > > >
> > > > On Tue, Feb 16, 2021, 03:40 Chaitanya Bapat <ch...@gmail.com>
> > wrote:
> > > >
> > > > > +1 for this automation proposal to make our releases Apache
> > compliant!
> > > > > Thanks Joe.
> > > > >
> > > > > Thanks sheng for patching the mxtheme piece!
> > > > >
> > > > >
> > > > > On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com>
> > wrote:
> > > > >
> > > > > > Hi dev community,
> > > > > >
> > > > > > Currently, when MXNet creates a new release, we manually create
> the
> > > > > source
> > > > > > archives using commands in the release runbook here:
> > > > > >
> > > > > >
> > > > > >
> > > > >
> > > >
> >
> https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
> > > > > >
> > > > > > Based on feedback from Apache, there are a few non-Apache 2.0
> > licenses
> > > > > > files that we should not distribute in the source archives, or
> > > > explicitly
> > > > > > call them out in the LICENSE file. The following files were
> > identified
> > > > as
> > > > > > non-AL2:
> > > > > >
> > > > > > 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> > > > > > 3rdparty/mkldnn/doc/assets/fonts/lato*
> > > > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> > > > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
> > > > > >
> > > > > >
> > > > >
> > > >
> >
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> > > > > >
> docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
> > > > > >
> > > > > > I believe we can simply remove the entire
> > 3rdparty/mkldnn/doc/assets
> > > > > > directory for mkldnn and not include it in our source archive.
> The
> > > > > > mxtheme has already been removed from the source tree (and
> > replaced by
> > > > > > doing a pip install of the mx-theme package instead) by @szha.
> > > > > >
> > > > > > I propose we automate this step of the release runbook by
> creating
> > a
> > > > > script
> > > > > > in the repo that checks out the passed tag, removes any
> problematic
> > > > files
> > > > > > that we can not distribute, and perform a apache-rat license
> check
> > to
> > > > > > ensure our source archive is compliant. Does anyone have any
> input
> > or
> > > > > > suggestions?
> > > > > >
> > > > > > Thanks,
> > > > > > Joe
> > > > > >
> > > > >
> > > >
> > >
> >
>
>
> --
> Sandeep Krishnamurthy
>
Re: [Proposal] Change to release process
Posted by sandeep krishnamurthy <sa...@gmail.com>.
Thanks Joe.
Automated script to prepare source tar which are compliant with Apache
license and also a list of excluded files in one place greatly helps in
preparing MXNet releases quickly and helps voters to easily validate
compliance checks.
Is this list a complete list of files that needs to be ignored, or may this
list expand as we run RAT license checks on 3rd party modules?
3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
3rdparty/mkldnn/doc/assets/fonts/lato*
3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
Thanks a lot for this contribution.
Thanks,
Sandeep
On Tue, Feb 16, 2021 at 9:34 AM Sheng Zha <zh...@apache.org> wrote:
> Thanks for bringing this up. If you have specific issues to share I would
> really appreciate it.
>
> On 2021/02/16 16:39:41, Aaron Markham <aa...@gmail.com> wrote:
> > Some folks use the docs build to make offline docs. Really need to make
> > sure those build properly from the release once you make that change with
> > mxtheme. There were a variety of patches going on with the local version
> of
> > it...IIRC... None of the bugs were being addressed at the time in the
> > mxtheme package level so that's why it was brought in locally and
> modified.
> > I'm guessing a pip install might appear to work, but then you're probably
> > going to find some display problems in the python docs. The folks that
> > worked on the front end code for the website would likely recall these
> > issues. If you make the change for how the site is built now then at
> least
> > it will break for everyone and it can be addressed in a way that can deal
> > with these license issues.
> >
> > On Tue, Feb 16, 2021, 1:41 AM Marco de Abreu <ma...@gmail.com>
> > wrote:
> >
> > > +1 definitely a good idea to create consistent releases
> > >
> > > On Tue, Feb 16, 2021, 03:40 Chaitanya Bapat <ch...@gmail.com>
> wrote:
> > >
> > > > +1 for this automation proposal to make our releases Apache
> compliant!
> > > > Thanks Joe.
> > > >
> > > > Thanks sheng for patching the mxtheme piece!
> > > >
> > > >
> > > > On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com>
> wrote:
> > > >
> > > > > Hi dev community,
> > > > >
> > > > > Currently, when MXNet creates a new release, we manually create the
> > > > source
> > > > > archives using commands in the release runbook here:
> > > > >
> > > > >
> > > > >
> > > >
> > >
> https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
> > > > >
> > > > > Based on feedback from Apache, there are a few non-Apache 2.0
> licenses
> > > > > files that we should not distribute in the source archives, or
> > > explicitly
> > > > > call them out in the LICENSE file. The following files were
> identified
> > > as
> > > > > non-AL2:
> > > > >
> > > > > 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> > > > > 3rdparty/mkldnn/doc/assets/fonts/lato*
> > > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> > > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
> > > > >
> > > > >
> > > >
> > >
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> > > > > docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
> > > > >
> > > > > I believe we can simply remove the entire
> 3rdparty/mkldnn/doc/assets
> > > > > directory for mkldnn and not include it in our source archive. The
> > > > > mxtheme has already been removed from the source tree (and
> replaced by
> > > > > doing a pip install of the mx-theme package instead) by @szha.
> > > > >
> > > > > I propose we automate this step of the release runbook by creating
> a
> > > > script
> > > > > in the repo that checks out the passed tag, removes any problematic
> > > files
> > > > > that we can not distribute, and perform a apache-rat license check
> to
> > > > > ensure our source archive is compliant. Does anyone have any input
> or
> > > > > suggestions?
> > > > >
> > > > > Thanks,
> > > > > Joe
> > > > >
> > > >
> > >
> >
>
--
Sandeep Krishnamurthy
Re: [Proposal] Change to release process
Posted by Sheng Zha <zh...@apache.org>.
Thanks for bringing this up. If you have specific issues to share I would really appreciate it.
On 2021/02/16 16:39:41, Aaron Markham <aa...@gmail.com> wrote:
> Some folks use the docs build to make offline docs. Really need to make
> sure those build properly from the release once you make that change with
> mxtheme. There were a variety of patches going on with the local version of
> it...IIRC... None of the bugs were being addressed at the time in the
> mxtheme package level so that's why it was brought in locally and modified.
> I'm guessing a pip install might appear to work, but then you're probably
> going to find some display problems in the python docs. The folks that
> worked on the front end code for the website would likely recall these
> issues. If you make the change for how the site is built now then at least
> it will break for everyone and it can be addressed in a way that can deal
> with these license issues.
>
> On Tue, Feb 16, 2021, 1:41 AM Marco de Abreu <ma...@gmail.com>
> wrote:
>
> > +1 definitely a good idea to create consistent releases
> >
> > On Tue, Feb 16, 2021, 03:40 Chaitanya Bapat <ch...@gmail.com> wrote:
> >
> > > +1 for this automation proposal to make our releases Apache compliant!
> > > Thanks Joe.
> > >
> > > Thanks sheng for patching the mxtheme piece!
> > >
> > >
> > > On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com> wrote:
> > >
> > > > Hi dev community,
> > > >
> > > > Currently, when MXNet creates a new release, we manually create the
> > > source
> > > > archives using commands in the release runbook here:
> > > >
> > > >
> > > >
> > >
> > https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
> > > >
> > > > Based on feedback from Apache, there are a few non-Apache 2.0 licenses
> > > > files that we should not distribute in the source archives, or
> > explicitly
> > > > call them out in the LICENSE file. The following files were identified
> > as
> > > > non-AL2:
> > > >
> > > > 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> > > > 3rdparty/mkldnn/doc/assets/fonts/lato*
> > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> > > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
> > > >
> > > >
> > >
> > docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> > > > docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
> > > >
> > > > I believe we can simply remove the entire 3rdparty/mkldnn/doc/assets
> > > > directory for mkldnn and not include it in our source archive. The
> > > > mxtheme has already been removed from the source tree (and replaced by
> > > > doing a pip install of the mx-theme package instead) by @szha.
> > > >
> > > > I propose we automate this step of the release runbook by creating a
> > > script
> > > > in the repo that checks out the passed tag, removes any problematic
> > files
> > > > that we can not distribute, and perform a apache-rat license check to
> > > > ensure our source archive is compliant. Does anyone have any input or
> > > > suggestions?
> > > >
> > > > Thanks,
> > > > Joe
> > > >
> > >
> >
>
Re: [Proposal] Change to release process
Posted by Aaron Markham <aa...@gmail.com>.
Some folks use the docs build to make offline docs. Really need to make
sure those build properly from the release once you make that change with
mxtheme. There were a variety of patches going on with the local version of
it...IIRC... None of the bugs were being addressed at the time in the
mxtheme package level so that's why it was brought in locally and modified.
I'm guessing a pip install might appear to work, but then you're probably
going to find some display problems in the python docs. The folks that
worked on the front end code for the website would likely recall these
issues. If you make the change for how the site is built now then at least
it will break for everyone and it can be addressed in a way that can deal
with these license issues.
On Tue, Feb 16, 2021, 1:41 AM Marco de Abreu <ma...@gmail.com>
wrote:
> +1 definitely a good idea to create consistent releases
>
> On Tue, Feb 16, 2021, 03:40 Chaitanya Bapat <ch...@gmail.com> wrote:
>
> > +1 for this automation proposal to make our releases Apache compliant!
> > Thanks Joe.
> >
> > Thanks sheng for patching the mxtheme piece!
> >
> >
> > On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com> wrote:
> >
> > > Hi dev community,
> > >
> > > Currently, when MXNet creates a new release, we manually create the
> > source
> > > archives using commands in the release runbook here:
> > >
> > >
> > >
> >
> https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
> > >
> > > Based on feedback from Apache, there are a few non-Apache 2.0 licenses
> > > files that we should not distribute in the source archives, or
> explicitly
> > > call them out in the LICENSE file. The following files were identified
> as
> > > non-AL2:
> > >
> > > 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> > > 3rdparty/mkldnn/doc/assets/fonts/lato*
> > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> > > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
> > >
> > >
> >
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> > > docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
> > >
> > > I believe we can simply remove the entire 3rdparty/mkldnn/doc/assets
> > > directory for mkldnn and not include it in our source archive. The
> > > mxtheme has already been removed from the source tree (and replaced by
> > > doing a pip install of the mx-theme package instead) by @szha.
> > >
> > > I propose we automate this step of the release runbook by creating a
> > script
> > > in the repo that checks out the passed tag, removes any problematic
> files
> > > that we can not distribute, and perform a apache-rat license check to
> > > ensure our source archive is compliant. Does anyone have any input or
> > > suggestions?
> > >
> > > Thanks,
> > > Joe
> > >
> >
>
Re: [Proposal] Change to release process
Posted by Marco de Abreu <ma...@gmail.com>.
+1 definitely a good idea to create consistent releases
On Tue, Feb 16, 2021, 03:40 Chaitanya Bapat <ch...@gmail.com> wrote:
> +1 for this automation proposal to make our releases Apache compliant!
> Thanks Joe.
>
> Thanks sheng for patching the mxtheme piece!
>
>
> On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com> wrote:
>
> > Hi dev community,
> >
> > Currently, when MXNet creates a new release, we manually create the
> source
> > archives using commands in the release runbook here:
> >
> >
> >
> https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
> >
> > Based on feedback from Apache, there are a few non-Apache 2.0 licenses
> > files that we should not distribute in the source archives, or explicitly
> > call them out in the LICENSE file. The following files were identified as
> > non-AL2:
> >
> > 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> > 3rdparty/mkldnn/doc/assets/fonts/lato*
> > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> > 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
> >
> >
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> > docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
> >
> > I believe we can simply remove the entire 3rdparty/mkldnn/doc/assets
> > directory for mkldnn and not include it in our source archive. The
> > mxtheme has already been removed from the source tree (and replaced by
> > doing a pip install of the mx-theme package instead) by @szha.
> >
> > I propose we automate this step of the release runbook by creating a
> script
> > in the repo that checks out the passed tag, removes any problematic files
> > that we can not distribute, and perform a apache-rat license check to
> > ensure our source archive is compliant. Does anyone have any input or
> > suggestions?
> >
> > Thanks,
> > Joe
> >
>
Re: [Proposal] Change to release process
Posted by Chaitanya Bapat <ch...@gmail.com>.
+1 for this automation proposal to make our releases Apache compliant!
Thanks Joe.
Thanks sheng for patching the mxtheme piece!
On Mon, Feb 15, 2021, 6:33 PM Joe Evans <jo...@gmail.com> wrote:
> Hi dev community,
>
> Currently, when MXNet creates a new release, we manually create the source
> archives using commands in the release runbook here:
>
>
> https://cwiki.apache.org/confluence/display/MXNET/Release+Process#ReleaseProcess-Step1.10.Createartifactsforthereleaseandpushtothedistfolder
>
> Based on feedback from Apache, there are a few non-Apache 2.0 licenses
> files that we should not distribute in the source archives, or explicitly
> call them out in the LICENSE file. The following files were identified as
> non-AL2:
>
> 3rdparty/mkldnn/doc/assets/fonts/fontawesome-webfont*
> 3rdparty/mkldnn/doc/assets/fonts/lato*
> 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/Asana-Math/otf*
> 3rdparty/mkldnn/doc/assets/mathjax/fonts/HTML-CSS/*/*/MathJax*
>
> docs/python_docs/themes/mx-theme/mxtheme/static/material-design-icons-3.0.1/iconfont/*
> docs/python_docs/themes/mx-theme/mxtheme/static/webfonts/fa-solid*
>
> I believe we can simply remove the entire 3rdparty/mkldnn/doc/assets
> directory for mkldnn and not include it in our source archive. The
> mxtheme has already been removed from the source tree (and replaced by
> doing a pip install of the mx-theme package instead) by @szha.
>
> I propose we automate this step of the release runbook by creating a script
> in the repo that checks out the passed tag, removes any problematic files
> that we can not distribute, and perform a apache-rat license check to
> ensure our source archive is compliant. Does anyone have any input or
> suggestions?
>
> Thanks,
> Joe
>