Porting this over from keystonejs/keystone#560, submitted by @ignlg

Should be added to a "tips / gotachas" page

This isn't a KeystoneJS' issue, it's just something about Mongoose (or maybe MongoDB) that you should be aware of.

After a List.model.collection.drop() all data and indexes are gone and, for a short period of time, you can insert duplicated unique: true fields without any errors or warnings.

I've discovered this running mocha tests. I dropped and redid the collections after every test and then uniqueness tests (trying to register/update users with an existing email, username) failed, but only when they were in the middle of other tests. Running alone they were fine.

I was able to query a find with an unique field and I've receive two and three results. After some mad research I've found that the issue came from the drop. Now I have replaced List.model.collection.drop() with List.model.remove(). More inefficient but safe in terms of model integrity.

I haven't got the time to go really deep into it yet but I hope it helps someone.

keystonejs/keystone#1003

I commented on some issue regarding hooks that documentation was not available for this and offered to write it.

But I am not sure where this should go in the documentation sections. It does not sound like something to Get Started, nor does it have to do with Database, it is probably Configuration-related somehow ? Not totally but I see some stuff there that are not completely configuration-related (as in "configuration options") so... Is it time for a new section ? Something like "features" ? Or should hooks go down there below "Disabling the Admin UI" ?

I was thinking about finding everytime callHook is present in keystone's master branch to give a full reference of available hooks with their parameters. Is it a good idea ? Should I use another branch ?

Seems to be a feature but it is not documented.

Ref keystonejs/keystone#2462

Add GeoPoint field explanation

I noticed that there are two "Getting started" pages - Getting Started and Getting Started Guide, with the latter one containing more detailed manual instructions.
Maybe renaming the second one to "Getting Started (Detailed)" or "Getting Started (Manual Instructions)" could help make the difference clearer?

Also, the detailed guide refers to the generator-keystone repository for instructions about using the generator - we could instead link to Getting Started, which presents the same information in a more beginner friendly format :)

As suggested by @murdockcrc in keystonejs/keystone#1681 it would be a good idea to provide an explanation and/or example of how (and where) to add error handling middleware in the documentation.

On my first try to create a model, i've noted that i'm missed the "name" mapping, and it seems mongo/keystone relies on a name field, OR a mapping to some field to show it on the Admin UI.

Also, its not very clear to me where that name is related to the object key to uniquely identify the object instance?

May be i can do a PR on this if i can understand this first.

I've searched for the feature of having the "cookie signin" option set, and how it works. Maybe i'm not looking for the right place? But i think it should be just below the "cookie secret" option right?

I'm looking for a way of "remember me". Its about that?

Update this section of the docs to include the new option mongo options. You can find most of the Mongoose options and examples here.

Something along the lines of...

This option allows you to provide additional connection options to Mongoose allowing more control over your MongoDB server, replica set, or cluster.

Example:
keystone.set('mongo options', {
    user: 'username',
    password: 'password',
    db: { safe: true },
    server: {
        auto_reconnect: true,
        socketOptions: {
            keepAlive: 1,
            connectTimeoutMS: 30000,
            socketTimeoutMS: 30000
        }
    },
    replset: {
        rs_name: 'myReplSet',
        readPreference: 'primary'
        socketOptions: {
            keepAlive: 1,
            connectTimeoutMS: 30000
        }
    }
})

I'm running through the Getting Started document and Yeoman isn't listed as a prerequisite. It probably should be since yo keystone will fail without it...

TextArray and NumberArray need documentation.
Ref keystonejs/keystone#1021

Transifex is free for OSS projects. With just a few minor changes, which we probably can do programmatically, we can prepare the KeystoneJS site to use Transifex.

We could easily use something like jsxgettext to extract the translatable strings, use the Transifex API to upload them any new strings/download the already translated strings, and a custom function to acts perform the string replacement.

This new workflow would eliminate the need the keep multiple copies of the site in multiple languages. In addition to the fact that we could use collaboration to translate the site in mores languages.
If you guys like the idea I will submit a PR with the required changes.

Reported by @jorisw in keystonejs/keystone#1675:

After doing some reverse engineering we found that upon first initialization, the name of the database being created by Keystone, is based on the name option in initOptions.

Would be nice if this were documented at http://keystonejs.com/docs/configuration or http://keystonejs.com/docs/database.

keystonejs/keystone#719

merged in keystonejs/keystone#2095 @alsoicode

keystonejs/keystone#1115

Currently, the build process is a WIP that makes it more work than it could be to update keystonejs.com with changes to this repo.

Specifically; there's no static asset build pipeline; changes to LESS / images / client-side javascript has to be manually moved across from the public folder into Keystone's gh-pages branch, and the built .html files need to be moved manually as well.

The current version number should be retrieved dynamically from npm, but for now could be an environment variable specified during build.

We should also add browserify / webpack into the build process to allow for Babel + npm package usage in the site and move away from the ancient javascript that's currently in use.

This actually might be in the sweet spot for webpack, since it has a jade loader; maybe it can handle the entire build process for us - replacing the current express and fs based solution(s), and adding nice things like live reloading (and react hot reloading)

@snowkeeper is this something you'd be interesting in looking into?

My ideal final state for the process is to have an npm script that is given a path to the local keystone clone, checks out gh-pages, builds the site, copies the changes across and commits them, finally switching back to the branch that was previously checked out.

Looks like we could use the gh-pages package to implement that without much work.

Ref keystonejs/keystone#2481

/cc @molomby

It's been requested to mention headstone in the documentation.
keystonejs/keystone#831 (comment)

document ip restrictions

Ref keystonejs/keystone#1212

keystonejs/keystone#1001

See keystonejs/keystone#1495

keystonejs/keystone#1096

keystonejs/keystone#769

keystonejs/keystone#1002

keystonejs/keystone#1094

Hey, I'd love to put together some basic documentation for utilizing the Email helper in Keystone, but I'm not sure what top level category would be appropriate?

It could possibly go in the "Configuration"->Services->Mandrill section, but I'm not sure that's totally appropriate. Thoughts @JedWatson ?

keystonejs/keystone#1081

see keystonejs/keystone#1553
and keystonejs/keystone#2206

See keystonejs/keystone#2472

According to @snowkeeper, it works something like this:

var keystone = require('keystone');
var util = require('util');
/*
    Custom FieldType Constructor
    @extends Field
    @api public
*/
function custom(list, path, options) {
    // add your options to this
    // call super_  
    custom.super_.call(this, list, path, options);  
}
/* inherit Field */
util.inherits(custom, keystone.Field);    
/* override or add methods */
custom.prototype.addToSchema = function() {
    // override schema instructions
}
/* Export Field Type */ exports = module.exports = custom;

var keystone = require('keystone');
Object.defineProperty(keystone.Field.Types, 'myField', { get: function() {
    return require(./customType.js');
} });

The docs show that the option schema should be a String but from my tests it's an object. I believe it's just a documentation mistake.

Add to http://keystonejs.com/docs/configuration/#options-server Ref keystonejs/keystone#1846

Ref keystonejs/keystone#272

added in keystonejs/keystone#1820

keystonejs/keystone#2145
@leshiple please share your browser operating system and device resolution to reproduce

I have search through the website and there is currently no mention of the TextArray & NumberArray field types and their options as referenced here: keystonejs/keystone#13

The email rules setting is an anti pattern and will be removed in 0.4

There are currently some sorting features in the Admin UI that I cannot seem to figure out if they work or not, or if I'm using them wrong. We need to better clarify the relationships, if any, between all three of the following as well as give better examples on usage for each:

sortable
sortContext
defaultSort

keystonejs/keystone#1105

Just noticed that Jade stripped the JSX from the universal routes example in the Getting Started guide.

keystonejs/keystone#1163

from keystonejs/keystone#1607

Re keystonejs/keystone#1584

Current we only document the format option, which is in what format the field is saved to the DB. The inputFormat option should be documented too, which is how a date can be entered into the field itself!

From http://keystonejs.com/docs/getting-started/:

package.json
This file describes our project for npm, including the fact that it depends on keystone.

{
  "dependencies": {
    "keystone": "latest",
    "underscore": "latest"
  },

You shouldn't depend on latest - if people do that when keystone breaks compatibility for 4.0 it'll break their app when they npm install again.

Either recommend "keystone": "^0.3" or tell people to npm install --save keystone if you don't want to have to update the documentation.

On the "Starting Keystone" section there's this instruction to run Keystone:

Now you're ready to run your application, so execute the following in your project's main folder:
node web

This command doesn't exists, right?

keystonejs/keystone#1000