{"action":"opened","issue":{"url":"https://api.github.com/repos/netlify/netlify-cms/issues/685","repository_url":"https://api.github.com/repos/netlify/netlify-cms","labels_url":"https://api.github.com/repos/netlify/netlify-cms/issues/685/labels{/name}","comments_url":"https://api.github.com/repos/netlify/netlify-cms/issues/685/comments","events_url":"https://api.github.com/repos/netlify/netlify-cms/issues/685/events","html_url":"https://github.com/netlify/netlify-cms/issues/685","id":265098314,"number":685,"title":"Add a Configuration doc","user":{"login":"verythorough","id":6111186,"avatar_url":"https://avatars2.githubusercontent.com/u/6111186?v=4","gravatar_id":"","url":"https://api.github.com/users/verythorough","html_url":"https://github.com/verythorough","followers_url":"https://api.github.com/users/verythorough/followers","following_url":"https://api.github.com/users/verythorough/following{/other_user}","gists_url":"https://api.github.com/users/verythorough/gists{/gist_id}","starred_url":"https://api.github.com/users/verythorough/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/verythorough/subscriptions","organizations_url":"https://api.github.com/users/verythorough/orgs","repos_url":"https://api.github.com/users/verythorough/repos","events_url":"https://api.github.com/users/verythorough/events{/privacy}","received_events_url":"https://api.github.com/users/verythorough/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-10-12T21:46:41Z","updated_at":"2017-10-12T21:46:41Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Configuration is covered briefly in the Quick Start, and even more briefly in the Intro, but really needs a dedicated page, providing a reference for all of the possible fields and settings for `config.yml`. Here's a basic outline taken from Issue #598:\r\n\r\nConfiguration options (config.yml)\r\n  - `backend`: explanation, available options, link to Authentication doc (track #600)\r\n  - `publish_mode`: how editorial workflow works with Git, link to content editor UI docs\r\n  - `media_folder`: what this means, what’s a valid path\r\n  - `public_folder`: relationship to `media_folder`, default, valid path info\r\n  - `collections`: each named collection displays in the sidebar of the app\r\n    - `name`\r\n    - `label`: note that this not pluralized (or is it? see #684)\r\n    - `folder` or `file`: briefly explain two types, link to dedicated doc (track #679)\r\n    - `filter`: explain, link to doc (track #679)\r\n    - `create`: valid with `folder` type only (?)\r\n    - `slug`: template options, default (?)\r\n    - `fields`: will generate key value pairs in data files, or in the frontmatter of markdown files \r\n      - `name`: note special `body` value for the main content section of md files\r\n      - `label`\r\n      - `widget`: explain, link to dedicated doc (track #619)\r\n      - `default`\r\n      - `required`: defaults to true\r\n      - `pattern`: basic validation described in validation.md (eventually removing this doc after copying the contents to this and the custom widgets doc (track #619)\r\n\r\nNote that in several sections, the doc refers to other, canonical docs, rather than repeating a full reference.\r\n\r\n"}}
{"actor":{"display_login":"verythorough"}}