Skip to content
This repository was archived by the owner on Jan 13, 2020. It is now read-only.

Add Github Pages Support #11

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

alexanderluna
Copy link

@alexanderluna alexanderluna commented Nov 13, 2018

I added Github Pages support with a customized Jekyll Theme. I added 4 categories which you can browse to find resources:

  • Udacity Lessons
  • Python specific resources
  • Math Specific resources
  • Deep Learning and Machine Learning resources

You can see a live version here: Awesome PyTorch Scholarship

I took all the links and split them into the 4 categories already. Currently there are only resource links for Python, Math and Deep Learning. For Udacity Lessons I just added the separate lessons as posts but they are empty for now.

I'm sure this will make the resources easier to categories and find what we need. Slack is exploding at the moment and there is a separate google sheet with lots of resource links. I think this can be the perfect place to save them all. Every contribution is registered on GitHub unlike the 10,000 message limit on slack as well.

@arnas
Copy link
Owner

arnas commented Nov 13, 2018

Cool, I will look into it after work

@arnas
Copy link
Owner

arnas commented Nov 13, 2018

Okay, I looked into this site and I am not really sure. Like for me, there are few points. It mostly acts as a more global wrapper, not sure if we need that? Secondly, I really like simple markdown file for its readability, where this site is a fancy, but very sparse information vise.
What is your opinion about these points?
Also maybe somebody else has a suggestion?

@alexanderluna
Copy link
Author

My main idea here is that the current readme and the resource links on slack are all unorganized. The list keeps growing and it just gets harder to find what you are looking for. Having a clean web interface with a link to which people can refer to makes it cleaner.

If you look at the Course section for example you will notice that Machine Learning, Math, Python and even a Game course are all just mixed together in an unordered list. That's at least how I fell about it.

screen shot 2018-11-13 at 10 07 16 pm

screen shot 2018-11-13 at 10 07 57 pm

@arnas
Copy link
Owner

arnas commented Nov 13, 2018

Yep, I know that there are some problems with the current readme list as the categorization is only in the initial state. But I am more in support to improve as a regular awesome list https://github.com/sindresorhus/awesome . Where all information is categorized in a simple fashion on easy to read a text. As if there would be a few I believe it should be very basic that could give a bit enhancement reading or navigation experience.
Additionally, as I am the supporter of open source I want to give a link to a direct repository so there would be a chance that people would read what GitHub is, how to contribute etc.

TL'DR I am all in on better categorization, more curated links, but a website like this is a bit against my idea of this repo.

P.s It's only my opinion if the community sees this as an improvement, I will agree to go that way 🙂

@nataliasverchkova
Copy link

As much as I reeally love the interface of the website, I agree with Arnas that readme is a more straight-forward way to contribute and easier/quicker to see what's there - this is especially important for such dynamic community with so many materials to share, less chances to duplicate something. Does the interface automatically update with the repo or you have to do manual work? Can they live together? (sorry, no experience in that)

@alexanderluna
Copy link
Author

alexanderluna commented Nov 14, 2018

@nataliasverchkova

Does the interface automatically update with the repo or you have to do manual work?

Yes, If you follow the organization, you can actually update both in one commit. You just have to update the markdown files in the _pages folder:

This is the python web interface:

https://alexanderluna.github.io/awesome-pytorch-scholarship/python/

This is the same python markdown file. This is the source for the web interface. You can choose to read the raw markdown or the website. Both coexist:

https://github.com/alexanderluna/awesome-pytorch-scholarship/blob/master/_pages/python.md

Github pages converts the markdown files into HTML pages.

@alexanderluna
Copy link
Author

alexanderluna commented Nov 14, 2018

You can in fact automatically update the markdown files and the website. I made a new commit to show you how it would look like:

https://github.com/alexanderluna/awesome-pytorch-scholarship

You can navigate around using markdown only and you of course edit the markdown files. Github pages takes care of using those same markdown files to create HTML versions.

@arnas @nataliasverchkova

@arnas
Copy link
Owner

arnas commented Nov 14, 2018

Yeah, I understand that, but that doesn't a change the fact that in my opinion the website adds unnecessary additional abstraction, which I am not sure if incoperates 'awesome' repo guidelines. Still I would really want additional feedback from the community, but it seems that people are not really active to discuss this feature :/

@arnas
Copy link
Owner

arnas commented Nov 14, 2018

Currently I am a bit busy for a few day ( local conference is going), but I will have some free time in the weekend, where I hope we will be able to find some middle ground @alexanderluna

@arnas
Copy link
Owner

arnas commented Nov 17, 2018

Okay, so I was thinking about this issue. Here are my thoughts:

  • As I want to follow awesome guidelines, the repository can have GitHub page as an optional thing, but it shoul'd be simple so that everybody would understand that it's just wrapper around content.
  • The current problem with categories that your website solves is just one of the variation for this general problem. My approach would be more simplified. Like just adding more subcategories that would indicate for example if the course is about math or deep learning.
  • Also I see your page as an entity that can exist on its own and preferably would link users to this repo ( to avoid splitting community)

@alexanderluna
Copy link
Author

Regarding your thoughts:

  1. You can still use the same markdown and link to the categories using markdown but it will add more bulk to the repo because of the styling, html and javascript to make the website work.

  2. Your approach works too and is simpler but a lot of people in the challenge have no experience with Github or Markdown or how to navigate through it.

  3. Currently it links already to this repo if you open the website and scroll down you will see a Github link to this repo.

  4. If you keep it in the master branch, you can edit, commit, pull, merge and update a single file and it would automatically update the blog. The second variant would be a separate entity but I would have to revisit any merge and copy the links over in the respective categories which would double the work.

Unfortunately, it is just us two discussing this as the rest either doesn't know how to use Github or are not actively participating on Github.

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

Successfully merging this pull request may close these issues.

3 participants