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 (minimal) metadata to schema #204 #237

Merged
merged 5 commits into from
Apr 27, 2016

Conversation

MarkBiesheuvel
Copy link
Contributor

There has been some discussion about adding a metadata section to the schema. So I have wrote this as a suggestion.

The desire to have a metadata section has been mentioned in different issues. What most of these have in common is that it needs to store information that is not related to the person of the resume, but to the document itself. For example a URL where the document is hosted or a version number of the document.

I thinks this type of information indeed warrants a new section, so I've added a single metadata object in the resume schema.

Since this is a section where different tools and programs might need different keys, I've allowed for additional properties. Since the issue specified a list of key/value pair, the additional properties are only allowed to be string and numbers, not arrays or objects.

Any feedback is welcome

@thomasdavis
Copy link
Member

thomasdavis commented Apr 27, 2016

Great initiative!

Alright, we can use this as the base PR to merge in.

Here is the original discussion #204

Let's start with changing metadata to meta

@thomasdavis
Copy link
Member

Let's just push get something simple through, the scope is pretty big. In essence, meta will just represent a formally documented place for third party vendors to appropriately dump anything they want.

@MarkBiesheuvel
Copy link
Contributor Author

Alright, sounds good.
I've renamed metadata to meta and I've also fixed my indenting.

@stp-ip
Copy link
Member

stp-ip commented Apr 27, 2016

Awesome. Do we want to add version into this basic PR too? That would cover the most basic use from resumejson itself. Know where to get the document, when it was modified and at which version it seems to be.

@thomasdavis
Copy link
Member

Let's leave version out until next PR.

@thomasdavis thomasdavis merged commit de60679 into jsonresume:v1.0.0 Apr 27, 2016
@stp-ip
Copy link
Member

stp-ip commented Apr 27, 2016

Ok.

@thomasdavis
Copy link
Member

Mostly because I am also unsure if we should document sub properties of meta in the schema. Generally the tools can take care of it, even the version.

@stp-ip
Copy link
Member

stp-ip commented Apr 27, 2016

I would say a standard version should be in. All tool related stuff should be documented to be inside of a namespace such as meta.awesomeeditor.key.

@thomasdavis
Copy link
Member

thomasdavis commented Apr 27, 2016

+1 to that, another PR to add a nested version property. I will write up some documentation about vendors name spacing.

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

Successfully merging this pull request may close these issues.

None yet

3 participants