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

Let's add description to entries #928

Closed
sindresorhus opened this issue Apr 1, 2017 · 16 comments
Closed

Let's add description to entries #928

sindresorhus opened this issue Apr 1, 2017 · 16 comments

Comments

@sindresorhus
Copy link
Owner

@sindresorhus sindresorhus commented Apr 1, 2017

I could use some help adding descriptions to entries in this list. The descriptions should be as succinct as possible. Short, but descriptive. They should be about the project/theme, NOT the list itself.

If you decide to do a PR, please do at least 10 descriptions.

Correct

- [AVA](…) - Test runner.

Not correct

- [AVA](…) - Full featured test runner with magic, unicorns, and many other things.

Not correct

- [AVA](…) - Resources for AVA.

Not correct

- [AVA](…) - Awesome resources.

Not correct

- [AVA](…) - List of testing resources.
@AllThingsSmitty

This comment has been minimized.

Copy link
Contributor

@AllThingsSmitty AllThingsSmitty commented May 2, 2017

I like this. I was just viewing Awesome Hacking and they have a table layout with a short description next to each repo that flows nicely.

Would you be using each individual repo's description, e.g., Awesome: "A curated list of awesome lists", and/or edit that to meet the succinct, descriptive requirement?

I'll happily update my own entries and others as I can.

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented May 2, 2017

or edit that to meet the succinct, descriptive requirement?

This. Most of the descriptions are not very good. I want good and succinct descriptions.

@AllThingsSmitty

This comment has been minimized.

Copy link
Contributor

@AllThingsSmitty AllThingsSmitty commented May 6, 2017

Got it.

Do you want to stick with your current formatting:

  • AVA - Test runner.

Or do you want to start adding items in a table:

Project Description
npm Package manager
AVA Test runner

The latter would take more time.

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented May 6, 2017

Current formatting.

@WillemMali

This comment has been minimized.

Copy link

@WillemMali WillemMali commented May 15, 2017

Hey, I've progressed a bit with my fork, would you like to discuss a data exchange program sometime?

I'd like it if we didn't have to duplicate our efforts. I've fixed a few broken links and standardized on only tracking HTTPS Git repos currently (and assuming that URL minus the .git is the project page) which works for all repos so far (I had to edit a few URLs because some linked to concrete files instead of project pages).

I have converted your Markdown to 372 YAML files (there goes a Sunday), validated the liveliness of all repos (I removed a single active repo with 19 pull requests and 5 months of inactivity) and normalized the links (I only store the https://.*/.*.git links now as they perfectly map to the the project pages) and set up a mirroring script (all repos together with complete revision history are 1.9B at the moment).

@WillemMali

This comment has been minimized.

Copy link

@WillemMali WillemMali commented May 15, 2017

I've also noticed that there are multiple different descriptions/taggings necessary to cover all repos: some only cover 1 thing (a language, a library, a framework, a methodology, a field of study), others cover something related to a thing (talks about library X) and some just have themes (developer and designer tools).

This made my current iteration of categories a bit disjointed, as I figured this out while copy-pasting a generated list of YAML descriptions into individual YAML files while adding categories (referencing your headers in the Markdown and the project pages themselves).

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented May 15, 2017

Hey, I've progressed a bit with my fork, would you like to discuss a data exchange program sometime?

Happy to review PRs for improvements, but Awesome is never going to switch away from Markdown.

@samjbmason

This comment has been minimized.

Copy link

@samjbmason samjbmason commented Aug 14, 2017

For descriptions for awesome projects in general is it possible to add slightly longer descriptions than the one liner. Is there precedent for that somewhere in another list?

Maybe something like an indented description under the point

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented Aug 14, 2017

@samjbmason Why? Can you provide an example of what you'd like to see?

@samjbmason

This comment has been minimized.

Copy link

@samjbmason samjbmason commented Aug 14, 2017

@samjbmason

This comment has been minimized.

Copy link

@samjbmason samjbmason commented Aug 15, 2017

Sorry @sindresorhus was on my phone last night so couldn't send over a example. So in the example I mentioned above instead of having the below:

I was wondering if would make more sense having a way of expanding the details, at first I though maybe a indented paragraph below like so:

Bu the more I think about it I wonder if it would make sense to have a nested list for bulleted details

It would be cool to get your feedback on any issues you forsee

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented Aug 28, 2017

@samjbmason Yes, it really depends on what information you're going to show. - [Title](URL) - Description. is good for most use-cases though. In your case, I would go with your last example.

@TSIIAM

This comment has been minimized.

Copy link

@TSIIAM TSIIAM commented Sep 7, 2017

@sindresorhus I wanted to help and added some descriptions, let me know if something is wrong, first PR.

@esthercuan

This comment has been minimized.

Copy link

@esthercuan esthercuan commented Jun 4, 2018

@sindresorhus first PR. Added some descriptions. Thank you for your time!

@aditisingh2362

This comment has been minimized.

Copy link
Contributor

@aditisingh2362 aditisingh2362 commented Sep 17, 2019

@sindresorhus This is my first PR. Added descriptions for some Back-End development. Thank you for your time!

@sindresorhus

This comment has been minimized.

Copy link
Owner Author

@sindresorhus sindresorhus commented Sep 23, 2019

Closing. Most important entries have descriptions now and for the rest, it's faster for me to do it myself than reviewing PRs for it.

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
7 participants
You can’t perform that action at this time.