mlpack / mlpack.org Goto Github PK

The new website looks fantastic!
I noticed that we only offer a single download option (just the src) which maybe adds little value to new users arriving to mlpack (especially for users without the time to compile mlpack and all the dependencies for a 'try out'). Since the builds are already producing ZIP/MSI artifacts, it would be nice to add one stable version of a pre-compiled mlpack as an alternative download option at http://mlpack.org/

The "Read More" link at the bottom of the Benchmarks section links to mlpack.org, which is the same page.

This is a follow-on from the discussion here: #9 (comment)

If you type mlpack.org in the browser URL bar, it brings the HTTP site by default, which is insecure.
Even though https is available, the web server should be configured to serve HTTPS as the default, and redirect http to https if that option is still required for some reason.

Right now the page http://www.mlpack.org/docs.html links to several different categories of documentation. This could be cleaned up into cards, more like the homepage, that make navigation to the desired documentation a little bit easier.

See this discussion for more information: #9 (comment)

The release date for version 3.0.0 is listed as March 30th, 2017, but the blog says 2018.

This is the source of the error: https://github.com/mlpack/mlpack.org/blob/master/index.html#L47

The IRC style uses a combination of the old and new CSS and looks a little weird: http://www.mlpack.org/irc/

We should go through and fix that.

After #26, the Doxygen style no longer matches the homepage (it was also not so great to begin with). We should make it match now for consistency.

@rcurtin On https://www.mlpack.org/community.html the links to mailing lists appear dead.

The link for "mlpack mailing list" leads to error 404: https://lists.mlpack.org/mailman/listinfo/mlpack

The link for "mlpack-git mailing list" also leads to error 404: https://lists.mlpack.org/mailman/listinfo/mlpack-git

The new website is much better with the navigation and accessibility part but I think the old dark mode was more soothing to the eyes.
An optional dark mode (an on-off switch at the top-right of the page or something similar) might be a good idea.

On opening a link from the tutorial page, there seems to be no way to find out what link was clicked from within the page(other than checking the content), due to lack of headers on the top of the pages. While this is not an issue when checking out a single page, it causes a lot of confusion when dealing with multiple tabs.

I looked into the issue further and it looks like there is a header, but its display is set to None in Doxygen.css .

div.header
{
  display: none;
}

/*
I wanted to submit a PR for this but I wasn't sure if I should, as this repo's docs page doesn't seem to contain the latest version's documentation links. Should I have done(/be doing) that? Just curious, I'm not really familiar with github's issue-PR etiquette. :/
*/

Recently there was a conversation on IRC asking about how to build the docs as well as the website locally.

I think it is a good idea to have the instructions present on this repository itself. I'll work on it if I have some free time this week, otherwise, feel free to work on it. :)

There's supposed to be a version selector in the upper right hand corner on pages like this:

https://www.mlpack.org/doc/mlpack-3.2.2/doxygen/index.html

but it doesn't appear to be displaying. It's likely a simple fix; perhaps some JS isn't loading correctly, or something. I haven't even looked at the console when loading the page yet; I just wanted to write this down so it doesn't get forgotten. :)

The datasets are obtained by a script from:
https://www.ratml.org/misc/datasets.tar.gz

This makes it hard to add additional datasets. Might it be worth making a separate repository for the datasets?

One reason we should move to github.io is you can edit the pages in markdown and wont have to go through the html craziness to make changes.

This is not really an issue, but a contribution. I struggled to pull the 2GB mlpack.org repo to just add a few lines of text... so here is a gist with a small modification to getstarted.md on how to use mlpack within Databricks. It's not rocket science, but I haven't seen any reference to this and it may be helpful for Databricks-like scientists. I have tested using the latest mlpack version and Databricks Runtime > 5.5.

@rcurtin if you believe it's helpful, could you please include this minor edit?

https://gist.github.com/gmanlan/4b156fd65ce32a7c8007996e5fc78f7d#databricks

Information on the GSoC page is a little outdated.

We have been a part of the program in 2013, 2014, 2016, 2017, and 2018, with a total of 30 students accepted for mlpack (all of whom succeeded at the program).

This should be updated to include 2019's contribution too.

Another place we can use cards is on the page http://www.mlpack.org/getstarted.html; perhaps one card per desired language or something like this.

This issue is made from the discussion here: #9 (comment)

@rcurtin: I think the issue you fixed during the test phase didn't make it to production when the website was deployed. The search bar is not showing up, which I guess is also related to the navigation bar.

http://mlpack.org/doc/mlpack-3.2.2/doxygen/build.html

Uncaught TypeError: Cannot read property 'value' of null
    at SearchBox.OnSelectItem (search.js:260)
    at init_search (search.js:789)
    at HTMLDocument.<anonymous> (build.html:33)
    at e (jquery.js:16)
    at Object.fireWith (jquery.js:16)
    at Function.ready (jquery.js:16)
    at HTMLDocument.e (jquery.js:16)

@rcurtin @zoq @shrit The online documentation seems to be malformed or missing C++ docs. There is also further sets of weirdness that are very confusing to new users.

On the mlpack docs page, clicking on Binding documentation under Python Bindings naturally leads to https://mlpack.org/doc/mlpack-4.0.0/python_documentation.html

However, this page then states "The C++ interfaces of mlpack are carefully documented and doxygen is used to provide automatically-generated searchable documentation". The provided link to https://mlpack.org/doc/mlpack-4.0.0/doxygen/index.html results in "Not Found" (ie. the doxygen page doesn't exist).

There is also further weirdness / inconsistencies on the Python documentation page, as well as all the binding documentation pages: in the menu on the left, all the languages are listed but not C++. This is confusing even for me.

Say someone found the page directly via Google, and now they can't find the C++ documentation for mlpack. At the very least there should be a stub page for C++, pointing the user to, for example, https://github.com/mlpack/mlpack/blob/master/doc/quickstart/cpp.md

Related to mlpack docs found via Google, folks can end up at the documentation for old versions of mlpack (eg. see issue mlpack/mlpack#3326), and end up getting really confused. I suggest to remove all old versions of the documentation and keep only the current one. Keeping old versions leads to problems like the above and is also a maintenance nightmare. Old documentation shouldn't be visible unless old versions of mlpack are actively maintained.

(As a side note, Armadillo used to have documentation based on Doxygen very early in its life. I've abandoned that very quickly after realising the Doxygen documentation is too difficult, ornate and cumbersome for typical users; it's very easy to get lost in it; even if one does find the right function, it's still difficult to grok. I think it would be very helpful for the uptake of mlpack if there was one simplified "go-to" documentation page similar to Armadillo and Ensmallen).

We should find a place on http://mlpack.org/community.html or another page to recognize the organizations that have supported mlpack's development or currently support it.

These would include:

• NumFOCUS
• Georgia Tech
• Symantec
• Google

If there are any others we should add feel free to comment. :)

In #9 we had a bunch of discussion about a new hero image for the frontpage:

#9 (comment)
#9 (comment)
#9 (comment)

This issue is a placeholder so that we don't forget about those discussions. :)

After #26, there are still a few pages that should be restyled to match.

One of them is https://www.mlpack.org/doc/stable/cli_documentation.html (and the other binding pages).

Problem location

https://www.mlpack.org/doc/mlpack-git/doxygen/tutorials.html
The problem persists in other pages of the documentation too.

Description of problem

The search bar at the top right of the documentation doesn't work.
I have tried pressing the 'Enter' key and clicking on the icon but nothing happens.

Upon inspecting in my browser and taking a look, this seemed to be the code responsible for the search box

<div id="MSearchBox" class="MSearchBoxInactive">   
      
<span class="left"><img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt="">           
<input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)">         
</span>        

<span class="right">           
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""></a>         
</span>       
</div>

It seems that the search box has been assigned to a css class that makes it inactive looking at the css class assignment in the first line.

I am not sure if this is the right place to this issue. Kindly let me know in which case I will reopen it at the right place.