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

Consistency of listings (help wanted) #4579

Open
eshellman opened this issue Oct 21, 2020 · 6 comments
Open

Consistency of listings (help wanted) #4579

eshellman opened this issue Oct 21, 2020 · 6 comments

Comments

@eshellman
Copy link
Collaborator

@eshellman eshellman commented Oct 21, 2020

with the flood of additions during Hacktoberfest, I'm seeing some sites/publisher/platforms added where links are inconsistently presented.
One example is books by goalkicker.
Most of our goalkicker listings look like this:
* [Spring Framework Notes for Professionals](https://books.goalkicker.com/SpringFrameworkBook) - Compiled from StackOverflow documentation
This give readers an idea of what to expect, and provides proper attribution. But not all our goalkicker links are formatted the same way.

Similarly, wikibooks links have been inconsistent - there's already a PR working to address that. #4230

Our course listing have expended a lot, and platform attribution has been inconsistent. It should be:
`* [title as given by resource](link, playlist if YouTube) - Instructor/Creator (platform)

PR's to improve consistency will be welcomed.

@kadhirash
Copy link
Member

@kadhirash kadhirash commented Oct 24, 2020

@eshellman I also noticed this inconsistency as well, would mentioning the platform as "YouTube" be necessary or is it implied if not mentioned? Similar to some links having "HTML" added to them but one could assume that it would be HTML else specified (e.g. PDF, EPUB, etc).

@SethiPandi what do you think?

@SethFalco
Copy link
Sponsor Member

@SethFalco SethFalco commented Oct 25, 2020

You may have noticed from how long all my replies are, but I've always been a fan of verbosity and disambiguation.

I feel it's always nice to be explicit, even for things a sensible user may infer, especially as there is no guarantee all users will be sensible.

The only arguably inferable thing in my opinion is HTML, but even then I think it's ideal, though it doesn't have to be mandatory, to specify it. I'm unsure where YouTube may be considered inferable, though.

The following only represents my personal experience, not the average user.
I say this as someone that personally expected all books to be PDFs until I realized most in fact weren't PDFs at all. (I prefer to read offline in KOReader.)
Of course, I know this now, but not as a person that was new to the repository and wasn't familiar with the conventions.

@eshellman
Copy link
Collaborator Author

@eshellman eshellman commented Oct 25, 2020

We can elide 'YouTube' and 'Github" from listings. For courses, the platform name is more useful because platforms provide more varied experiences and may have registration requirements.

'HTML' should be indicated only when it is the only format available - often our link lead to a web page which offers links to content of multiple types.

@kadhirash
Copy link
Member

@kadhirash kadhirash commented Oct 26, 2020

@eshellman okay great that sounds good

@eshellman
Copy link
Collaborator Author

@eshellman eshellman commented Nov 6, 2020

We need to compile provider-specific consistency notes. So...

Please add the "Compiled from StackOverflow documentation" attribution we use for goalkicker books
For youtube, we prefer "playlist" links and the name of the producer/creators

from PRs:
MIT OpenCourseWare #5087
Wikibooks #4230
udacity #3880
leanpub

@davorpa
Copy link
Member

@davorpa davorpa commented Aug 23, 2021

@eshellman

Should be meta-list or language agnostic moved at begining? These improves TOC between each translated listing.

Eg.:

  1. Meta list
  2. Language agnostic

(take into account pending #5249 renaming)

davorpa added a commit to davorpa/free-programming-books that referenced this issue Sep 7, 2021
eshellman pushed a commit that referenced this issue Sep 7, 2021
davorpa added a commit to davorpa/free-programming-books that referenced this issue Oct 6, 2021
Moves some resources related with topic found in `Misc` and `Data Science`
It consolidates this section 🚀

Improves EbookFoundation#4579
eshellman pushed a commit that referenced this issue Oct 7, 2021
* refactor(courses): Add AI category

Add  `Artificial Intelligence` section suggested in #5569 (comment)

Resolves #5569
Locks Resolves #5569

* refactor(courses): Move `Elements of AI`

Moved to  `Artificial Intelligence` section suggested in #5569 (comment)

Resolves #5569
Locks Resolves #5569

* refactor(courses): Movings to `Artificial Intelligence`

Moves some resources related with topic found in `Misc` and `Data Science`
It consolidates this section 🚀

Improves #4579

* fix(courses): Give credits to instructor/platforms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants