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.

Sign up for GitHub

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

Jump to bottom

Design YAML for project metadata #1

Open
simonwiles opened this issue Aug 15, 2023 · 2 comments
Open

Design YAML for project metadata #1

simonwiles opened this issue Aug 15, 2023 · 2 comments
Assignees
@simonwiles @mbingenheimer @kdean2023

Comments

@simonwiles
Copy link
Member

We need a structure for project metadata -- perhaps something as simple as this will do:

projectName: <project name>

description: |
  ## Project description

  A description of the project with **markdown** available.
  (Mostly valuable so as to be able to include [links](http://project-upstream.com) and/or images, e.g. ![Project Logo](http://project-upstream.com/logo.png)

contact: [email protected]

credits:
  - person one <[email protected]>
  - person two <[email protected]>
  - person one
@simonwiles
Copy link
Member Author

I'm thinking of per-(sub)project metadata here; so a .yaml file in each data repository with these details (perhaps less/more/others?) describing and detailing provenance (and probably license, now that I think about it) etc. for each dataset.

@simonwiles
Copy link
Member Author

(see nanyang-temples/thailand-public#2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@simonwiles simonwiles

@mbingenheimer mbingenheimer

@kdean2023 kdean2023

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@simonwiles @mbingenheimer @kdean2023