Sync and Readme

This page explains Dribdat, an open source platform for data-driven team collaboration (such as Hackathons), covering the basic usage of the application. For more background see ABOUT, and for technical details visit the README. For a printable version of this document see 📄 Handbook for hackathons powered by Dribdat

How to Sync like a Pro

We do not force or even expect you to use the editor on this platform to work on your content. Some teams are content with just adding a link to their Demo or uploading their Pitch presentation into Dribdat. Visit the User guide to learn more about editing content in Dribdat.

When you Edit your project, you can find the Readme in the Details tab. This feature allows you to connect documentation from your open source repository on GitHub, an online document at Etherpad, and many other collaboration platforms - see the list below.

Getting started

To use this function, just put the URL to your remote content into the README field when creating a new project. Or find it in the Details editor on an existing challenge or project.

From time to time the data will be refreshed. You can use the Sync (synchronise) button on the bottom of your project page to refresh your changes at any time.

Even if you have a Readme, you can still Edit your project to add notes or answer questions relevant to the event you are at, and Details to tweak the Contact, Download, Source, Image links and more.

The contents of all projects in an event can also be synced at once by the admin.

Supported sites

• Codeberg (Gitea)
• GitHub
• GitLab
• Bitbucket
• Pretalx
• Etherpad
• HackMD and CodiMD
• DokuWiki
• Google Docs (* you must enable "Publish to web", as shown below)

Leave us an issue or drop into the Discussions if you have ideas for other data sources we should support.

Using Google Docs

A special note if you are trying to attach a document from Google Drive.

If you want to use Google Slides to make a presentation, it is best to Publish to Web, and copy the Embedding link (just the URL) as your Presentation link. The following applies to attaching the contents of Google Docs:

Activate publishing in this dialog, and finally copy the link that is shown, so that you can paste it into the README of your dribdat project: