From cdf977ff3fb1f718591eeb2a24cea77415e66418 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Fri, 3 Apr 2020 14:48:51 +0200 Subject: [PATCH] doc: add documentation index --- doc/README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..ea4687e5a --- /dev/null +++ b/doc/README.md @@ -0,0 +1,43 @@ +# Documentation + +This document is the entrypoint to different guides, divided in three groups: + +* User guide: these documents are designed to help users of the service, to better +understand all the available features and how to use them. + +* Developer guide: these documents are designed to help developers who want to either +integrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet +itself by developing new features or fixing bugs. + +* DevOps guide: these documents are designed for DevOps folks, system administrators +or anyone who wishes to deploy and operate their own Jitsi Meet instance. + +## User guide + +Work in progress. + +## Developer guide + +### Web + +* [iframe API](https://github.com/jitsi/jitsi-meet/blob/master/doc/api.md) +* [Jitsi Meet development](https://github.com/jitsi/jitsi-meet/blob/master/doc/development.md) + +### Mobile + +* [Building the mobile apps](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile.md) +* [SDK usage examples](https://github.com/jitsi/jitsi-meet-sdk-samples) +* [Enabling Dropbox support](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile-dropbox.md) +* [Enabling Google authentication](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile-google-auth.md) + +## DevOps guide + +* [Quick install](https://github.com/jitsi/jitsi-meet/blob/master/doc/quick-install.md) +* [Docker install](https://github.com/jitsi/docker-jitsi-meet/blob/master/README.md) +* [Google Calendar, MS Calendar, Dropbox integrations](https://github.com/jitsi/jitsi-meet/blob/master/doc/integrations.md) +* [Video tutorials on deployment and scalability](https://jitsi.org/tutorials/) +* [Configuring a video SIP gateway](https://github.com/jitsi/jitsi-meet/blob/master/doc/sipgw-config.md) +* [Enabling speaker stats](https://github.com/jitsi/jitsi-meet/blob/master/doc/speakerstats-prosody.md) +* [Enabling TURN](https://github.com/jitsi/jitsi-meet/blob/master/doc/turn.md) +* [Networking FAQ](https://github.com/jitsi/jitsi-meet/blob/master/doc/faq.md) +* [Cloud APIs](https://github.com/jitsi/jitsi-meet/blob/master/doc/cloud-api.md)