ICLR/iclr.github.io

Document format of json and yaml files

srush opened this issue · 5 comments

srush commented

We should have documentation for each of the files used for the data storage on the website.

soumyac1999 commented

Can we also organise the static files into different folders like data, images, js, css, etc? The static folder looks too cluttered presently.

srush commented

sure.

srush commented

actually let's make this two separate things. This one is about the backend. You can organize the frontend files in static/

soumyac1999 commented

I think this issue got closed by mistake.

Is this format below fine for the documentation?
@srush, can you help fill in the ??? and socials.yml section?
For sponsors, which file should be documented - sponsors.yml or sponsors.tsv?
I couldn't understand quite a few fields in site_data.json which is not documented in the following.

faq.yml

FAQ:
    - Section: SECTION_NAME
      QA:
        - Question: "QUESTION"
          Answer: "ANSWER"
        - Question:
          Answer:
        ... 
    - Section:
      QA:
        ...

schedule.yml

Time Slots:

# ALL TIMES have to be in UTC
time_slots:
  5a: [5:00 AM,7:00 AM]
  8a: [8:00 AM,10:00 AM]
  11a: [11:00 AM, 11:30 AM]
  12p: [12:00 PM, 2:00 PM]
  2p: [2:00 PM, 2:30 PM]
  4p: [4:00 PM, 4:30 PM]
  5p: [5:00 PM, 7:00 PM]
  7p: [7:00 PM, 7:30 PM]
  8p: [8:00 PM, 10:00 PM]

Events:

conference:
    - day: "yyyy-mm-dd"
      events:
        - slot: # Slot id from the above time slots (eg 5a)
          type: poster/qa
          short: ???
        - slot:
          type:
          short:
        ...
    - day: ...

socials.yml

socials:
    - name: 
      organizers: 
      website:
    - name:
      organizers:
      website:
    ...

speakers.yml

speakers:
    - speaker: NAME(S)
      title: "Title of talk"
      image: # Path to image of speaker(s) in static/images
      institution: # Of the speaker(s)
    - speaker:
      title:
      image:
      institution:
    ...

workshops.yml

workshops:
    - name: NAME
      organizers: "Name1 · Name2 · Name3" 
      website: Link to Workshop Website
      chat: ???
    - name:
      organizers:
      website:
      chat:
srush commented