Skip to content

Best Practices for passing data to the Website Working Group

Eric Phetteplace edited this page Aug 23, 2018 · 10 revisions

Steps for transferring data to the Website Working Group:

  • Create an issue in this repository describing the data you're providing & how it should be used
  • Create a Google Drive folder containing the assets you wish to transfer
  • Share the folder with either the #conference-website Slack channel, or the chair and co-chair of the Website Working Group (see the wiki) giving them edit access

If you're uncertain of the format we're expecting your data to be in or when we'll need your data, please contact us! Opening an issue, chatting in #conference-website Slack channel, and contacting either the chair or co-chair are all great.

When making changes or additions to a previous data submission, we'd appreciate it if the entire process was followed again. If, for instance, a new speaker image is added to a folder which was shared with us previously, we may not be alerted to the presence of the new asset. Creating an image and a fresh sharing location makes it easier for us to see what data has been processed and what remains to be done.

If someone on your committee is comfortable doing so, you can simply submit pull requests directly to this repository with the necessary data. This is quick and works very well for images but less so for other data such as the details of a conference talk (unless you are familiar with the structure of the site).

Image Filenames

We'd appreciate it if you used consistent, lowercase filenames with underscores instead of spaces. For speaker images, the format is "{{surname}}_{{other names}}.jpg". For sponsors, please use the sponsor's name (acronyms are fine) without the word "logo" or the image's dimensions appended to the file name. Typical file types are fine but please use three-letter, lowercase file format extensions (e.g. jpg, png, gif).

Good Examples

  • mit.jpg
  • index_data.gif
  • lorde_audre.png
  • curtis_jamie_lee.jpg

Bad Examples

  • MIT.jpg
  • Index_Data_logo_30x30.JPEG
  • univ_ill_uc_large.jpg
  • Jackson_Michael.jpg
  • Borges Jorge Luis.jpg