Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 3.71 KB

README.md

File metadata and controls

75 lines (59 loc) · 3.71 KB
Raw

The Stack Exchange Timeline

Glitch Deploy Licence GitHub commit activity

This is currently hosted on Glitch, at se-timeline.glitch.me.

Contributing

Please direct any queries & feedback by creating an issue on GitHub.

You can also contribute to updating the events using the instructions below, then opening a pull request. After review and merging to the main branch, a GitHub action will then automatically update the Glitch project.

Don't worry about making mistakes, a GitHub action will run on any pull request to validate changes to the JSON file, and the PR can only be merged if it passes.

Updating Events

The timeline data is stored in the timeline_data.json file as JSON.

If you are unsure how to manually edit the event data using JSON, you should use the Event Editor to import an existing event or create a new one, following which you can paste the output in a new "Update Timeline" issue.

Event Object Properties

Event items are nested in the "items" array.

  • To add a new event, simply add a new item to the array, in the position sorted by date, in reverse chronological order (i.e.: latest first).
  • To update an existing event, change the corresponding item's properties.
  • To remove an event, remove the corresponding item from the array.

The properties of each event item is as follows. **The properties date_str and title are required.

{
  "date_str": "2016-05-08", // ** displayed date string, in the format YYYY-MM-DD (UTC)
  "title": "SOBotics founded", // ** title
  "slug": "sobotics-founded", // this is auto-generated if not set
  "type": "stackoverflow chat group blog", // described using single words separated by space
  "summary": "SOBotics creates bots to help with...", // a short summary displayed in italics
  "body": "<p>body text</p>", // body html
  // an array of CSS classes, also used for filtering
  "classes": [
    "featured-event", // feature with a red border
    "tag-moderator", // event is about moderator
    "tag-staff", // event is about staff
    "tag-resignation", // event is about resignation
    "tag-reinstatement", // event is about reinstatement
    "tag-site-graduation" // event is about site graduation
  ],
  // an array of button links
  "links": [
    {
      "text": "chat room",
      "url": "https://chat.stackoverflow.com/rooms/111347/sobotics"
    }
  ],
  // an array of links visually displayed like SE tags
  "tags": [
    {
      "text": "licensing",
      "url": "https://meta.stackexchange.com/questions/tagged/licensing?tab=newest"
    },
    {
      "text": "licensing",
      "url": "https://meta.stackoverflow.com/questions/tagged/licensing?tab=newest"
    }
  ],
  // another event's slug prefixed with a #
  "linkedEvent": "#another-event-slug",
  // url of an image (for site graduation events)
  "icon": ""
}

Comments starting with // are not actually allowed in the JSON file, and is only used in the example above to describe each property.

All double quotes, especially in the title, summary, and body properties, need to be escaped with a backslash like this: \"