Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add website to infrastructure #87

Merged
merged 35 commits into from
Mar 8, 2021
Merged

Conversation

bytesnake
Copy link
Member

@bytesnake bytesnake commented Feb 15, 2021

This PR adds an entry website, where we can pitch the idea about linfa and have some announcements/news section.

  • add static page based on the Zola generator to docs/website: rendered
  • move all implementations into algorithms/ because the root became too messy
  • adds workflows which automatically builds the latest rust docs and website and publishes them to gh-pages
  • complete announcement in news section

sorry for the large number of file changes, you can search for diffs in a subpath with git diff master docs/website/ 😅

@bytesnake bytesnake marked this pull request as ready for review March 7, 2021 22:42
@bytesnake bytesnake changed the title [WIP] Add website to infrastructure Add website to infrastructure Mar 7, 2021
@codecov-io
Copy link

codecov-io commented Mar 7, 2021

Codecov Report

Merging #87 (4bf4644) into master (d0363a1) will increase coverage by 0.11%.
The diff coverage is 85.71%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #87      +/-   ##
==========================================
+ Coverage   55.14%   55.25%   +0.11%     
==========================================
  Files          62       62              
  Lines        5063     5071       +8     
==========================================
+ Hits         2792     2802      +10     
+ Misses       2271     2269       -2     
Impacted Files Coverage Δ
algorithms/linfa-bayes/src/gaussian_nb.rs 55.46% <ø> (ø)
...thms/linfa-clustering/src/appx_dbscan/algorithm.rs 21.42% <ø> (ø)
...infa-clustering/src/appx_dbscan/cells_grid/cell.rs 52.04% <ø> (ø)
...linfa-clustering/src/appx_dbscan/cells_grid/mod.rs 56.52% <ø> (ø)
...nfa-clustering/src/appx_dbscan/cells_grid/tests.rs 100.00% <ø> (ø)
...linfa-clustering/src/appx_dbscan/clustering/mod.rs 44.44% <ø> (ø)
...nfa-clustering/src/appx_dbscan/clustering/tests.rs 90.00% <ø> (ø)
...fa-clustering/src/appx_dbscan/counting_tree/mod.rs 44.28% <ø> (ø)
...-clustering/src/appx_dbscan/counting_tree/tests.rs 100.00% <ø> (ø)
...infa-clustering/src/appx_dbscan/hyperparameters.rs 22.22% <ø> (ø)
... and 53 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d0363a1...4bf4644. Read the comment docs.

Copy link
Member

@quietlychris quietlychris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides just wondering if we want to host directly from the rust-ml group, everything else looks good! I've clicked around the current site, and didn't run into any bugs. If you're satisfied, this looks good to go from me :)

docs/website/config.toml Outdated Show resolved Hide resolved
Copy link
Member

@Sauro98 Sauro98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work on the website💪🏻 I believe that cleaning up the main folder by moving all the algorithms to their subfolder was a very good idea too and it looks much nicer now.

I only have two suggestions:

  • Should we add the link to the website in the readme for linfa?
  • In the About page of the website (in the mobile version) the table obviously does not fit, I was wondering if maybe it would be better to make only the table side-scrollable and not the whole page? This is a very picky comment so feel free to ignore it 😅

README.md Show resolved Hide resolved
docs/website/content/snippets/elasticnet.md Outdated Show resolved Hide resolved
@bytesnake
Copy link
Member Author

Fantastic work on the website💪🏻 I believe that cleaning up the main folder by moving all the algorithms to their subfolder was a very good idea too and it looks much nicer now.

I only have two suggestions:

* Should we add the link to the website in the readme for linfa?

* In the `About` page of the website (in the mobile version) the table obviously does not fit, I was wondering if maybe it would be better to make only the table side-scrollable and not the whole page? This is a very picky comment so feel free to ignore it sweat_smile

yes and yes, will figure something out for the table later this day :)

@bytesnake
Copy link
Member Author

Besides just wondering if we want to host directly from the rust-ml group, everything else looks good! I've clicked around the current site, and didn't run into any bugs. If you're satisfied, this looks good to go from me :)

I would publish the website at rust-ml.github.io/linfa/, because it's also under the rust-ml organization

 * link website in README
 * make table horizontally scrollable in mobile version
 * update elasticnet example
 * update `base_url` link in configuration
@bytesnake
Copy link
Member Author

bytesnake commented Mar 8, 2021

okay let's merge and see what happens

@bytesnake bytesnake merged commit c8acc78 into rust-ml:master Mar 8, 2021
@bytesnake
Copy link
Member Author

damn the links in README are not updated 😅 I will push another commit when the website is online

@bytesnake
Copy link
Member Author

fixed in latest commit and everything seems fine 👍

@Sauro98
Copy link
Member

Sauro98 commented Mar 8, 2021

Everything seems to be working fine 🚀

@relf
Copy link
Member

relf commented Mar 8, 2021

Links to algorithms in About page are broken.

@bytesnake
Copy link
Member Author

yep fixed in f79fe9e

@relf
Copy link
Member

relf commented Mar 8, 2021

Nice website! Bravo! 👏 👏 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants