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

Meetup data as JSON/YAML #227

Closed
zerok opened this issue May 14, 2017 · 11 comments
Closed

Meetup data as JSON/YAML #227

zerok opened this issue May 14, 2017 · 11 comments

Comments

@zerok
Copy link
Contributor

zerok commented May 14, 2017

Would it make sense to make the meetup data machine-parsable using something YAML(preferred) or JSON similar to what we have right now with the talks? This might help with re-using meetup information for the video archive and other future endeavours ;)

@plaindocs
Copy link
Contributor

Yes, absolutely. I'll track down the list of meetup talks we have.

Thoughts on

  • a file per meetup containing videos in exactly the same format as speaker files
  • a single file of meetup videos with the meetup info inside the json

@zerok
Copy link
Contributor Author

zerok commented May 14, 2017

Oh, I'm more talking about the meetups themselves, basically what we have right now on http://www.writethedocs.org/meetups/

Should we there perhaps generate a file per meetup containing something like this?

country: USA
state: New York
city: New York City
notes: |
  Organised by [@WriteTheDocsNYC](https://twitter.com/WriteTheDocsNYC)
sessions:
  - title: Some session
    speakers: ...

@plaindocs
Copy link
Contributor

I see where you're going, and that does make sense. I have some reservations:

  • We're going to run into US / non US geographical issues.
  • We're going to make it slightly harder for non technical people to edit meetup info

@zerok
Copy link
Contributor Author

zerok commented May 14, 2017

What do you mean with your first point? The state should be optional anyway :)

Regarding the second point: That's mostly why I'm proposing YAML instead of JSON as it would make editing and also validating the data much easier :)

@plaindocs
Copy link
Contributor

All of our other data is in json, so I don't think using YAML makes sense. And even though it is easier to edit and validate, it will still put some people off.

But overall I think the advantages of using a data file outweigh the disadvantages.

@plaindocs
Copy link
Contributor

So what is the best json format for this.

@zerok
Copy link
Contributor Author

zerok commented May 14, 2017

{
  "continent": "North America",
  "city": "New York City",
  "state": "New York",
  "country": "USA",
  "sessions": [
    // Same as in the speakers.json files
  ]
}

I'd say.

Regarding JSON was YAML: Given the formatting issues we already have with the speakers files (esp. the abstracts are really a pain to maintain right now) I was going to suggest moving them over to YAML next, anyway :-P

The main advantage of YAML for this kind of data is the lower quote/braces count and multiline support :)

@plaindocs
Copy link
Contributor

OK, fully agree on the pain in the abstracts.

@zerok
Copy link
Contributor Author

zerok commented May 15, 2017

I'm currently running into some minor issues with recommonmark but otherwise work is progressing rather well. I might be done with it by the end of the conference 🙂

@plaindocs
Copy link
Contributor

Awesome. I'll take a look as soon as I have a minute.

@zerok
Copy link
Contributor Author

zerok commented May 15, 2017

I haven't uploaded any code yet and the laptop is at home 😉

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

No branches or pull requests

2 participants