-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
[Content collections] Remove "unsupported file type" warning #9671
Conversation
🦋 Changeset detectedLatest commit: 4b8ab03 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yay! Makin' people happy, @bholmesdev ! 🥳
Left a couple of thoughts on the changeset, and I'll just remind you of what we say in docs in case you think we should amend anything there:
A collection entry is any piece of content stored inside of your content collection directory. Entries can use content authoring formats including Markdown (.md) and MDX (.mdx using the MDX integration) or as one of two supported data formats: YAML (.yaml) and JSON (.json). We recommend using a consistent naming scheme (lower-case, dashes instead of spaces) for your files to make it easier to find and organize your content, but this is not required. You can also exclude entries from being built by prefixing the filename with an underscore (_).
We make it sound like you can't even add non-content files at all, so no need to "correct" the need for underscore. But, if a lot of people are doing this, we could possibly choose to mention this pattern if you think it makes collections more compelling.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is blocked because it contains a minor
changeset. A reviewer will merge this at the next release if approved.
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@sarah11918 Thanks for the edits! Yes, I noticed that paragraph scanning our docs. I think we're okay leaving the docs as-is, and letting users discover asset colocation naturally. I expect most who want it will just... try it! And see that it works as expected 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs happy with changeset! Signing off!
We decided to remove the "unsupported file type" warning from Content Collections during our roadmap discussions. This requirement led to several bugs and special cases overtime, including an "ignore list" for
.DS_Store
and special handling for image assets.Now, all files that are not content (
.md
) or data (.json
) are ignored by default. This means underscores are no longer required for these files. You can still use underscores to hide content or data entries from collection queries.Changes
unsupported
file type from warning logs and type-generation internalsTesting
unsupported
to now expectignored
DS_Store
and image assetsDocs