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 Collection Types doc #679

Closed
verythorough opened this issue Oct 11, 2017 · 1 comment
Closed

Add Collection Types doc #679

verythorough opened this issue Oct 11, 2017 · 1 comment

Comments

@verythorough
Copy link
Contributor

verythorough commented Oct 11, 2017

Collections are explained briefly in the Quick Start, and nowhere else. I've included most configuration options in the proposed outline for a Configuration doc (#685), but the collection types of file, folder, and filter are complex enough to require their own doc. Here's a rough outline pulled from #598 (with the order changed slightly):

Collections: file, folder, filter
(explain the differences, show config examples for each)

  • folder:
    • grouping of separate files based on the same template, stored in the same folder
    • UI widgets will be identical for all items in the folder (or all matching the filter, below)
    • may or may not be able to add new items (depending on create field)
  • filter:
    • used with folder type
    • can be used to pull only items matching the specified field value
    • requires field and value: must be an exact match
  • file:
    • single file or grouping of files, with fields specified for each file individually
    • can be useful for data files with settings or highly customized pages
    • cannot be filtered; cannot add new items
  • Note: regardless of collection type, each item in the main area of the collection browser represents a separate file (though separate files may be combined into a single published page via templating)
@verythorough
Copy link
Contributor Author

I forgot to mention that @tech4him1 started some work in this direction with #656 (then closed it in favor of this outline). Much of the work he did there pulls from the Quick Start, but I think we'll probably want to be more "reference-like" and less "instructional" with the structure of this doc, if that makes sense.

@verythorough verythorough changed the title Add Collections doc Add Collection Types doc Oct 12, 2017
This was referenced Dec 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant