Documentation

Here you should find everything you need from getting started with creating your Profile to more advanced topics. We welcome contributions, check out the LinkFree Repo  and the documentation source and the  on GitHub for more information.

Events

Hosting or attending events, let people know what you are up to by adding these events to your Profile.

Example of LinkFree Profile events

All future events also appear on the Events page for the app.

Example of LinkFree events

Add Event

  1. Create a folder that matches your GitHub username in the data directory and then in that folder create another folder called events. For example data/eddiejaoude/events/

  2. In your folder add a json file with any name you like. We recommend putting the date first and then appending it with the event name. For example 2023-09-13-javascript-conference.json.

If you need help on how to edit this file, please see the Editing Guide

  1. This json file will contain one object for the event and must have six fields, isVirtual and/or isInPerson, color, name, description, date and url, which will look like this:
{
  "isVirtual": true,
  "isInPerson": true,
  "color": "red",
  "name": "Open Source GitHub reviews",
  "description": "In this livestream I will be going reviewing your **Open Source projects** and profiles! I will be joined by **Amanda**, a Developer Advocate.",
  "date": {
    "start": "2022-12-09T16:00:00.000+00:00",
    "end": "2022-12-09T17:00:00.000+00:00",
    "cfpClose": "2022-10-09T17:00:00.000+00:00"
  },
  "url": "https://www.youtube.com/watch?v=iqIFD02OkVE"
}
PropertyRequiredDescription
isVirtual / isInPersontrueIs the event virtual or in person or both
colortrueWhat color would you like this milestone to be displayed in
nametrueName of the event
descriptiontrueMore details about the event, this can include markdown
datetrueStart and end date plus time of the event
cfpClosefalseThe date of when the CFP to submit a talk closes
urltrueWhere can people learn more about the event
  1. Now you can commit your file and create a Pull Request. For more details please see Editing Guide