[Bug 1811410] New: Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Bug ID: 1811410
           Summary: Re-Review Request: mkdocs - Python tool to create HTML
                    documentation from markdown sources
           Product: Fedora
           Version: rawhide
          Hardware: All
                OS: Linux
            Status: NEW
         Component: Package Review
          Severity: medium
          Priority: medium
          Assignee: [e-mail]
          Reporter: [e-mail]
        QA Contact: [e-mail]
                CC: [e-mail]
  Target Milestone: ---
    Classification: Fedora

Spec URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...
SRPM URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...
Description: MkDocs is a fast and simple way to create a website from source
files written
in Markdown, and configured with a YAML configuration file, the documentation
can be hosted anywhere, even in free hosting services like Read the Docs and
GitHub Pages.
Fedora Account System Username: cheeselee

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Robin Lee  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
         Depends On|                            |1811409, 1811377
           Doc Type|---                         |If docs needed, set a value

Referenced Bugs:

https://bugzilla.redhat.com/show_bug.cgi?id=1811377
[Bug 1811377] Review Request: python-lunr - A Python implementation of Lunr.js
https://bugzilla.redhat.com/show_bug.cgi?id=1811409
[Bug 1811409] Review Request: python-mdx_gh_links - Python-Markdown
Github-Links Extension

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Robin Lee  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
         Depends On|                            |1771376

Referenced Bugs:

https://bugzilla.redhat.com/show_bug.cgi?id=1771376
[Bug 1771376] CVE-2019-14751 python-nltk: directory traversal vulnerability
allows attackers to write arbitrary files via ../ [fedora-all]

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

José Matos  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |ASSIGNED
                 CC|                            |[e-mail]
              Flags|                            |fedora-review?

--- Comment #1 from José Matos  ---
I am taking this review just as I did for #1811409 and #1811377.

Could you, please, update the url's for spec and srpm since they are not valid
anymore.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Robin Lee  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Blocks|                            |1815725, 1815726, 1815727,
                   |                            |1815728, 1815729
              Flags|                            |needinfo?([e-mail])

--- Comment #2 from Robin Lee  ---
Spec URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...
SRPM URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...

Changes:
- Requires python3dist(lunr) python3dist(nltk)
- Obsoletes mkdocs-basic-theme

(In reply to José Matos from comment #1)
> I am taking this review just as I did for #1811409 and #1811377.
>
> Could you, please, update the url's for spec and srpm since they are not
> valid anymore.

Thanks! And all the requirement of this package has been satisfied in Rawhide.

Referenced Bugs:

https://bugzilla.redhat.com/show_bug.cgi?id=1815725
[Bug 1815725] Re-Review Request: mkdocs-cinder - A clean responsive theme for
the MkDocs
https://bugzilla.redhat.com/show_bug.cgi?id=1815726
[Bug 1815726] Re-Review Request: mkdocs-material - A material design theme for
MkDocs
https://bugzilla.redhat.com/show_bug.cgi?id=1815727
[Bug 1815727] Re-Review Request: mkdocs-alabaster - Alabaster port for MkDocs
https://bugzilla.redhat.com/show_bug.cgi?id=1815728
[Bug 1815728] Re-Review Request: mkdocs-bootstrap - Bootstrap theme for MKDocs
https://bugzilla.redhat.com/show_bug.cgi?id=1815729
[Bug 1815729] Re-Review Request: mkdocs-bootswatch - Bootswatch themes for
MkDocs

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

José Matos  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|needinfo?([e-mail]) |

--- Comment #3 from José Matos  ---
(In reply to Robin Lee from comment #2)
> Changes:
> Requires python3dist(lunr) python3dist(nltk)

These are not necessary. They are built automatically:
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_dependenc...
> Obsoletes mkdocs-basic-theme

The other topic that could be addressed is the the RobotSlab font. A part of
the fonts are already in Fedora.
python-sphinx_rtd_theme has an example where the part that is already packaged
in Fedora is symlinked.

See:
https://src.fedoraproject.org/rpms/python-sphinx_rtd_theme/blob/master/f/pyt...

Other than that the package is in good shape. :-)

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #4 from Robin Lee  ---
Spec URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...
SRPM URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...

Changes:
Add symlinks to the Roboto fonts.

(In reply to José Matos from comment #3)
> (In reply to Robin Lee from comment #2)
> > Changes:
> > Requires python3dist(lunr) python3dist(nltk)
>
> These are not necessary. They are built automatically:
> https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/
> #_dependencies

These requirements are not automatically generated.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #5 from José Matos  ---
(In reply to Robin Lee from comment #4)
> > These are not necessary. They are built automatically:
> > https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/
> > #_dependencies
>
> These requirements are not automatically generated.

python3dist(lunr) is generated:

Requires
--------
mkdocs (rpmlib, GLIBC filtered):
    /usr/bin/python3
    bootswatch-fonts
    fontawesome-fonts
    fontawesome-fonts-web
    google-roboto-slab-fonts
    js-jquery1
    js-jquery2
    lato-fonts
    python(abi)
    python3.8dist(click)
    python3.8dist(jinja2)
    python3.8dist(livereload)
    python3.8dist(lunr)
    python3.8dist(markdown)
    python3.8dist(pyyaml)
    python3.8dist(setuptools)
    python3.8dist(tornado)
    python3dist(lunr)
    python3dist(mdx-gh-links)
    python3dist(nltk)

Notice as lunr appears above.

Regarding nltk I am curious why it is a dependency of mkdocs, it is not
mentioned in the documentation and it does not show in the code.

BTW the License should be:

License: BSD and Tumbolia

The Tumbolia appears because of file mkdocs-1.1/mkdocs/utils/ghp_import.py

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #6 from Robin Lee  ---
Spec URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...
SRPM URL:
https://download.copr.fedorainfracloud.org/results/cheeselee/review/fedora-r...

Changes:
- Drop explicit lunr requirement
- License specified to BSD and Tumbolia

(In reply to José Matos from comment #5)
> (In reply to Robin Lee from comment #4)
> > > These are not necessary. They are built automatically:
> > > https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/
> > > #_dependencies
> >
> > These requirements are not automatically generated.
>
> python3dist(lunr) is generated:
> Requires
>
> mkdocs (rpmlib, GLIBC filtered):
>     /usr/bin/python3
>     bootswatch-fonts
>     fontawesome-fonts
>     fontawesome-fonts-web
>     google-roboto-slab-fonts
>     js-jquery1
>     js-jquery2
>     lato-fonts
>     python(abi)
>     python3.8dist(click)
>     python3.8dist(jinja2)
>     python3.8dist(livereload)
>     python3.8dist(lunr)
>     python3.8dist(markdown)
>     python3.8dist(pyyaml)
>     python3.8dist(setuptools)
>     python3.8dist(tornado)
>     python3dist(lunr)
>     python3dist(mdx-gh-links)
>     python3dist(nltk)
>
> Notice as lunr appears above.

Fixed
> Regarding nltk I am curious why it is a dependency of mkdocs, it is not
> mentioned in the documentation and it does not show in the code.

Mkdocs requires an optional feature of lunr. And that option feature of lunr
requires nltk.
> BTW the License should be:
>
> License: BSD and Tumbolia
>
> The Tumbolia appears because of file mkdocs-1.1/mkdocs/utils/ghp_import.py

Fixed.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

José Matos  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|fedora-review?              |fedora-review+

--- Comment #7 from José Matos  ---
Thank you for taking care of my requests.

You explanation regarding the dependenvies is fully convincing since nltk is an
extra dependency of lunr. Now it all makes sense. :-)
Eventually if you add the dependency to python-lunr it will be picked directly
from python-lunr dependency.
In any case this is an academic discussion since you are the maintainer of both
packages and thus it is you call where to place the dependency.

Now the revision:

The license is correct and the spec file follows all the Fedora guidelines.

Running fedora-review shows three warnings:

1) The license is in index.html that is not marked as %license.
2) The package name already exists in Fedora.
3) Large documentation must go in a -doc subpackage.

They are false positives:
1) is funny and bogus. The license is already included so it does not make
sense to add index.html;
2) sure enough, after all this is a re-review;
3) those files need to be there and there is already a -doc subpackage.

So the package is approved.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410
Bug 1811410 depends on bug 1811409, which changed state.

Bug 1811409 Summary: Review Request: python-mdx_gh_links - Python-Markdown Github-Links Extension
https://bugzilla.redhat.com/show_bug.cgi?id=1811409

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|MODIFIED                    |CLOSED
         Resolution|---                         |ERRATA

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Robert-André Mauchin  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |[e-mail]
           Assignee|[e-mail]    |[e-mail]

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410
Bug 1811410 depends on bug 1771376, which changed state.

Bug 1771376 Summary: CVE-2019-14751 python-nltk: directory traversal vulnerability allows attackers to write arbitrary files via ../ [fedora-all]
https://bugzilla.redhat.com/show_bug.cgi?id=1771376

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ON_QA                       |CLOSED
         Resolution|---                         |ERRATA

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410
Bug 1811410 depends on bug 1811377, which changed state.

Bug 1811377 Summary: Review Request: python-lunr - A Python implementation of Lunr.js
https://bugzilla.redhat.com/show_bug.cgi?id=1811377

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ON_QA                       |CLOSED
         Resolution|---                         |ERRATA

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Fedora Update System  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |MODIFIED

--- Comment #8 from Fedora Update System  ---
FEDORA-2020-505423242a has been submitted as an update to Fedora 31.
https://bodhi.fedoraproject.org/updates/FEDORA-2020-505423242a

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #9 from Fedora Update System  ---
FEDORA-2020-c75b5fcaaf has been submitted as an update to Fedora 32.
https://bodhi.fedoraproject.org/updates/FEDORA-2020-c75b5fcaaf

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Fedora Update System  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|MODIFIED                    |ON_QA

--- Comment #10 from Fedora Update System  ---
FEDORA-2020-505423242a has been pushed to the Fedora 31 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing
--advisory=FEDORA-2020-505423242a *`
You can provide feedback for this update here:
https://bodhi.fedoraproject.org/updates/FEDORA-2020-505423242a

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information
on how to test updates.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #11 from Fedora Update System  ---
FEDORA-2020-c75b5fcaaf has been pushed to the Fedora 32 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing
--advisory=FEDORA-2020-c75b5fcaaf *`
You can provide feedback for this update here:
https://bodhi.fedoraproject.org/updates/FEDORA-2020-c75b5fcaaf

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information
on how to test updates.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

Fedora Update System  changed:

What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ON_QA                       |CLOSED
         Resolution|---                         |ERRATA
        Last Closed|                            |2020-04-05 00:15:53

--- Comment #12 from Fedora Update System  ---
FEDORA-2020-c75b5fcaaf has been pushed to the Fedora 32 stable repository.
If problem still persists, please make note of it in this bug report.

[Bug 1811410] Re-Review Request: mkdocs - Python tool to create HTML documentation from markdown sources

https://bugzilla.redhat.com/show_bug.cgi?id=1811410

--- Comment #13 from Fedora Update System  ---
FEDORA-2020-505423242a has been pushed to the Fedora 31 stable repository.
If problem still persists, please make note of it in this bug report.