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

Fail on bad metadata #71

Open
bmschmidt opened this issue May 5, 2021 · 1 comment
Open

Fail on bad metadata #71

bmschmidt opened this issue May 5, 2021 · 1 comment
Assignees
Labels

Comments

@bmschmidt
Copy link

Wax has constraints on metadata that users might not immediately notice--e.g., that ids cannot include a period or uppercase letters, and that certain fields have special meanings.

If these rules are violated, a site will build but break in unpredictable ways. Would you consider instead throwing an error that explains what needs to happen differently? I suspect this will save users time by helping them identify where things have gone wrong.

@bmschmidt
Copy link
Author

A rider on this: the documentation is a little vague on what the special id fields are:

It includes:

  • ['Some fields are needed for Jekyll and Wax, and should not be used in your metadata file. For example, Jekyll has rules for its date field. You should avoid this key and use _date, like in the example spreadsheet above.

  • The fields thumbnail, full, and manifest (seen below) are generated by Wax when you process your collection images. You should not manually create these fields (unless you know what you’re doing!), and should avoid these keys in your metadata.

Best I can tell, there a few other special fields that should be added to this list:

  • Like 'label', have a special meaning which you should understand:
    • order
  • Like thumbnail and full, should not be included in your input unless you completely understand what you're doing:
    • collection, layout.
  • Whatever the special jekyll fields like "date" are.

@mnyrop mnyrop self-assigned this Jul 17, 2023
@mnyrop mnyrop added the chore label Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants