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

Add a Configuration doc #685

Closed
verythorough opened this issue Oct 12, 2017 · 0 comments · Fixed by #885
Closed

Add a Configuration doc #685

verythorough opened this issue Oct 12, 2017 · 0 comments · Fixed by #885

Comments

@verythorough
Copy link
Contributor

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:

Configuration options (config.yml)

  • backend: explanation, available options, link to Authentication doc (track Add instructions for auth with Netlify Identity and Git Gateway #600)
  • publish_mode: how editorial workflow works with Git, link to content editor UI docs
  • media_folder: what this means, what’s a valid path
  • public_folder: relationship to media_folder, default, valid path info
  • collections: each named collection displays in the sidebar of the app

Note that in several sections, the doc refers to other, canonical docs, rather than repeating a full reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants