Curated by @jonhmchan. Like Bento? Leave me a tip.
About
This is where all the community submitted resources on Bento are managed and stored. The main site at http://www.bentobox.io/ uses all the data here to render the link share on the main page, in addition to supplementary content on the detail views. Read the instructions below to submit links and contribute.
Testing and validation
Please make sure that you validate your JSON before submitting a pull request using JSONLint. Invalid JSON that passes through will break the site. Also, there is currently no way to test any drafts of your JSON changes on the new site since Bento is no longer static. There are plans to change this to make it easier for developers, but when that change may happen is unclear.
Make a contribution
content.json (in the gh-pages branch) is where all the resources are defined. In each resource there is a name of the technology, a short description, what the user should learn next, and an ordered list of resources related to that technology. There are a few things to keep in mind when doing editing:
- Links should be free (no pay walls) and take the user immediately to the relevant information (i.e. for html go to the html exercise in codecademy, rather than codeacademy's home page - the user should not have to do any searching to start learning)
- Links should come from a single source on a single topic, so a blog post rather than the homepage for a blog, a tutorial rather than a list of tutorials, etc.
- Links should generally be about the topic as a whole, and not about a special subject within that topic (i.e. an introduction to CSS rather than different ways to float divs)
- All names must be lowercase (even in the $then fields and descriptions)
- Descriptions should be no more than 100 characters long
- Descriptions should not use any complex jargon when possible
- Home should be the top domain when possible (official documentation or the wikipedia article if a concept)
- Next lessons ($then) are meant to signify what the next lesson should be (1) immediate and (2) obvious (3) next or related steps from the current box
- Next lessons should not include prerequisites (javascript should not be in angular $then)
- Each LINK (not the box) must be categorized as "easy" (level: 0, no previous experience necessary), "medium" (level: 1, requires "easy" information), and "hard" (level: 2, requires "medium" information)
- Only the first two "easy" links are shown, in the order of the array
- Link names should be the title of the destination
If you have any questions, please don't hesitate to contact me by tweeting @jonhmchan