level / leveljs.org

Source code of leveljs.org

leveljs.org

This is the source code for leveljs.org.

Stylus Structure

The Stylus files are located under assets/static/styl, with the following architecture...

├── assets
  └── styl
    ├── components
    ├── globals
    ├── pages
    ├── sections
    └── main.styl

Where:

• compontents — are reusable components for common elements (such as buttons, forms, typography)
• globals — reusable variables, mixins and base for the website
• pages — subpages of the website (comments, profile, 404, landing, etc.)
• sections - individual sections of a page (header, footer, community, platforms, etc.)

Template Structure

├── assets
  └── templates
    ├── index.pug
    ├── footer.pug
    └── layout.pug

Where:

• layout.pug — basic layout file for the entire website
• index.pug — the page content (here being the landing page)
• footer.pug - footnotes

Contributing

Level/leveljs.org is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the Contribution Guide for more details.

For contributors

git clone https://github.com/Level/leveljs.org.git
cd leveljs.org
npm i
npm start

For maintainers

Manually trigger the GitHub Actions workflow to deploy to gh-pages.

Donate

Support us with a monthly donation on Open Collective and help us continue our work.

License

MIT

leveljs.org's Issues

Replace broken TypeKit fonts

And it could use fonts that are a tad lighter and friendler.

@ralphtheninja WDYT about:

Illustrations explaining how LevelDB works

I've already asked delightful @lynnandtonic whether she would be willing to contribute her time and she said yes. So at some point we could add an illustration or two.

---

@hij1nx said:

Here are some ideas! :) It would be cool to have continuous, subtle animated diagrams of

how snappy compression works
lots of things going into a bucket, getting smaller.

how compaction works
over time, smaller things at the top go downward into a bucket. as they get organized and go lower, they join together.

keys and values VS. tables
many things with little handles VS. one handle that is connected o lots of other little things

---

@ralphtheninja said:

The analogy with the library that @dominictarr often mentions is very good illustration of how leveldb operates. Most recent books in a small pile at the library desk, old books that are 'forgotten' in basement level 44, shelf 23094834 with a lot of dust on top of them :)

RequireBin link: No index.js in this gist

Deployment has removed images

See 12cda76, which means e.g. https://leveljs.org/img/badge.svg is now dead. It's been a year since the last deployment here, so a lot changed in the action. I don't see an obvious suspect in their changelog, but I think it's caused by https://github.com/peaceiris/actions-gh-pages/blob/7166f2caa423717780ff24040f0163cbe511c18c/src/git-utils.ts#L120 in combination with:

leveljs.org/.gitignore

Line 3 in b36d31f

dist/

Take care of the security issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

command to deploy to gh-pages

if we're gonna have a build step it would be cool to have this be the workflow:

for contributor:

git clone
cd leveldb.org
npm i
npm start
# hack on the codez, send pull request

for maintainer:

git pull fork-branch
# make sure changes look good
npm run deploy

where npm run deploy builds the static site, switches to the gh-pages branch and puts the built site in the root, and then does git push origin gh-pages

Update content for `level@8` and `abstract-level`

Follow-up for #62. There are some links to update, and the introduction too.

Blog

Migrating issues from the repo in my profile, so they won't get lost :)

---

It would be nice to have a blog eventually.

Incorrect date for workshop?

https://github.com/Level/leveldb.org/blob/bb9ed1a4d56e482e9ddce938069faeb40d7ed168/assets/jade/index.jade#L86-L88 is 2014 but is mentioned in upcoming

Update live demo to 8.0.0 syntax (`new Level`)

The breaking change of version 8.0.0 requires a switch from

const level = require('level')
const db = level('db')

to

const { Level } = require('level')
const db = new Level('db')

The demo appears to still refer to 5.0.0. The outdatedness sparks Stack Overflow questions such as Error: "level is not a function" when using LevelDB.

Legal demand to remove leveldb.org

Google's lawyers have demanded this organization stop using leveldb (I'm not sure if it's trademarked?). I removed the CNAME file from the gh-pages branch so that it no longer serves the current build. In master I've renamed any references to leveldb in the README.md file. Someone motivated might want to get the domain leveljs.org since it's available and deploy an updated version of the site that is more specific to the js part of this project.

CI email address

Bus factor and all, it'd be nice to have a [email protected] address. For the AppVeyor org account and GitHub machine user. Or perhaps a generic [email protected].

Continuing from Level/leveldown#309 (comment) by @0x00A:

I do maintain that domain, any ideas for setting up email that we could all access? There might be something better than me adding it to my Google Apps account.

@ralphtheninja @juliangruber ideas?

Auto-deploy on tagged commit with Travis CI

See https://docs.travis-ci.com/user/deployment/pages/

Fix & expand live demo

The Live Demo on leveljs.org, powered by runkit, imports an outdated version of level. I think we'll need to contact runkit to fix that.

After that we could add more examples that you can freely edit, forming a playground. As suggested in Level/database#1 (comment).

Use double quotes in npm scripts

This should make it compatible with windows in addition to bash, zsh, etc. E.g. instead of:

"git-commit": "git add -A . && git commit -a -m 'gh-pages update'"

Write

"git-commit": "git add -A . && git commit -a -m \"gh-pages update\""

(also the -a is not necessary)

Intro to LevelDB paper link 404

In the Papers section, the link to Intro to LevelDB leads to a 404.

How To's / Examples

We should just move this over to RequireBin? Acquisition has made Here Is How a low priority. /cc @maxogden

Example

I think we should add a simple example/tutorial.

Something like npm install level

var level = require('level')

var db = level('./mydb')

db.put('name', 'LevelUP', function (err) {
  if (err) return console.log('Ooops!', err) // some kind of I/O error

  db.get('name', function (err, value) {
    if (err) return console.log('Ooops!', err) // likely the key was not found

    // ta da!
    console.log('name=' + value)
  })
})

(straight from the LevelUp readme).

I think this should be after the logo and before the feature.

Rename or delete?

In the event of Google complaining on our project name we need to take some action with this repository. Maybe start by renaming it and clearing the README?

cc @vweevers @chjj

Release feed

Something hooked up to tags on Github/npm would be nice.

Replication

A: how do i do x? B: what exactly do you want to do? there's 50 modules for that! replication.

Not sure what was up with this one, but I guess we want to have some infromation about replication.

Getting started section

It would be great to have either a section or an entire subpage dedicated to getting started. It's cool there's the requirebin runnable example but for noobs (like me!) it doesn't really explain much :(