Home

📖 This Wiki is for technical documentation. The full project documentation can be found here: about.openki.net

There are 3 main sections, directed at different use-cases:

• Docs for developers (How Openki is built, how to contribute, useful tipps & tricks)
• Docs for web-admins (How to embed Openki, Infoscreens, API, Translations)
• Docs for sysadmins (Setting up the app, maintaining, deploying)
• Security

Docs for developers:

🌞 Submissions are warmly welcome. To submit a change, fork this repo, commit your changes, and send us a pull request. In the interest of having a open and welcoming environment for everyone, we agreed on our Code of Conduct. By participating in this project you agree to abide by its terms.

• Dev Setup
• Automated Tests
• Naming and Syntax Convention
• Modules - explained (Intro, Translations, Editor, Comments..)
• Useful stuff - working with meteor & openki
• Styles - all about working on the style
• Future - thoughts about further development (the abstract layer)

Docs for web-admins:

Useful stuff for website administrators using Openki.

Views

There are several views for a variety of usecases

• Infoscreens (kiosk-views)
• Frames (embeding, iframes...)

APIs

• Calendar interface iCal (for any other website or calendar application)
• JSON interface

Queries

• Query options and filters: Filter regions groups and stuff in URLs / Links

Translation

• Translations with meteor-messageformat (i18n)

Docs for sysadmins:

• Setup
• Deploying using Meteor-up
• Config Files
• Migrating db (deployed to meteor.com)
• Removing obsolete translations
• Watching Openki Log

Security

• Security