Home
Hi there! If you're reading this then that means you're interested in either using dashboard for your event, or contributing to the development of dashboard. Awesome! Thank you so much for your trust and support.
So let's get right into the weeds shall we? This wiki is going to be the central and only source for documentation on dashboard. For the sake of everyone's sanity we're going to be splitting all of the documentation into two sections.
User facing documentation assumes that you are an organizer who wishes to use dashboard at your own event. This documentation will focus on the following items.
- Setting up your own version of dashboard locally to test & preview changes
- Forking and modifying the configuration repository in order to customize dashboard for your own event
- Deploying dashboard to a production environment for your event
- Showing you how to update your deployment of dashboard when we release a new version (with as little impact to your configuration as possible)
Developer facing documentation assumes that you'd like to contribute changes to the main dashboard repository. In order to do so you will need to be familliar with every part of the user facing experience. As a result this documentation is mostly the same, but it contains some more details about the implementation of every feature that we have. You'll have to dive deeper than the configuration repository if you're a developer, though you also need to know how it works in order to modify it if necessary.
We absolutely encourage you to be both a user and developer of dashboard. However for your own sanity it's probably best that you keep the two projects isolated on your machine and that you don't develop in your deployed instance. This will save you a lot of headache in dealing with the git submodules. If you're a submodule god and feel that you can manage, we won't stop you though :)
With all of that out of the way here's how we'll format the wiki. Any pages that are specific to either users or developers will have titles in the following format.
[User] Deployment instructions[Developer] Contribution instructions
Any page without the [User/Developer] prefix exists for everyone and will be split up into two sections. The user section will come first, and the developer section second. If you're a developer we highly recommend that you read the entire page so that you have a clear understanding of what's going on.
Pages marked [Archive] are legacy pages that we haven't gotten a chance to update yet. We'll get to them as soon as we can! In addition we have a few pages marked [Appendix] that are extra pages which contain supplementary information that isn't crucial to read but that you can peruse at your leisure if you're interested.
Thanks for choosing dashboard run your event. We hope it'll be as beneficial to you as it has been to us.