jsonresume / jsonresume.org

The mono repo that builds the homepage, utils, ui components, registry and anything else
https://jsonresume.org
68 stars 18 forks source link

docs(website): Fix attribute `description` #1

Closed roschaefer closed 1 year ago

roschaefer commented 1 year ago

Changes

This confused me a lot. I thought the website is right and the reference implementation is wrong: https://github.com/rbardini/jsonresume-theme-even/blob/main/components/projects.js#L15

But no, the website is wrong. The source of truth for jsonresume schema is here: https://github.com/jsonresume/resume-schema/blob/master/schema.json

How to test

  1. Visit https://www.jsonschemavalidator.net/
  2. Paste schema.json
  3. Set "additionalProperties" to false in the entire document
  4. Paste the sample json from the website
  5. See:
    
    Found 1 error(s)

Message: Property 'summary' has not been defined and the schema does not allow additional properties. Schema path:

/properties/projects/items/additionalProperties



 ## Other

Why don't we simply take the sample json from `resume-schema`?
https://github.com/jsonresume/resume-schema/blob/master/sample.resume.json
vercel[bot] commented 1 year ago

@roschaefer is attempting to deploy a commit to the thomasdavis's Team Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jsonresume-org-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 30, 2023 1:03am
jsonresume-org-registry ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 30, 2023 1:03am
thomasdavis commented 1 year ago

Thanks for this @roschaefer

That must of confused a lot of people.

The projects attribute isn't widely used in templates though.

Thanks again!