Document markdown data structure

[micleners]

Currently there are several directories of markdown files:

• Meetings
• Talks
• Speakers
• Sponsors
• Hosts

My understanding is the meetings frontmatter provide relationships for the other 4 data types.

We want to have the relationships well defined and described for new comers to understand. So, the task at hand is to come up and document a clear data schema for the relationship between markdown files.

One tool that might be useful to document the data structures is: https://mermaidjs.github.io/#/

[travi]

its worth being aware that the relationships between the markdown files are currently defined here:

site/gatsby-config.js

Lines 5 to 10 in c2b478f

	mapping: {
	'MarkdownRemark.frontmatter.talk': 'MarkdownRemark.frontmatter.title',
	'MarkdownRemark.frontmatter.speaker': 'MarkdownRemark.frontmatter.name',
	'MarkdownRemark.frontmatter.sponsor': 'MarkdownRemark.frontmatter.name',
	'MarkdownRemark.frontmatter.host': 'MarkdownRemark.frontmatter.location'
	},

[travi]

ideally, i'd like to see this done in a way that an image can be generated and referenced from a README.md in the content directory.

mermaid is a great fit for this type of approach since the text file can be versioned and an npm package can be used as a cli to generate such an image. i'm not sure they support support an appropriate chart type for representing foreign-key relationships, though.

[travi]

it looks like there is an open issue for adding a ER Diagram chart type, but i don't imagine that will get added soon. maybe the class diagram could work for now?