Переглянути джерело

doc: add documentation index

master
Saúl Ibarra Corretgé 5 роки тому
джерело
коміт
cdf977ff3f
1 змінених файлів з 43 додано та 0 видалено
  1. 43
    0
      doc/README.md

+ 43
- 0
doc/README.md Переглянути файл

@@ -0,0 +1,43 @@
1
+# Documentation
2
+
3
+This document is the entrypoint to different guides, divided in three groups:
4
+
5
+* User guide: these documents are designed to help users of the service, to better
6
+understand all the available features and how to use them.
7
+
8
+* Developer guide: these documents are designed to help developers who want to either
9
+integrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet
10
+itself by developing new features or fixing bugs.
11
+
12
+* DevOps guide: these documents are designed for DevOps folks, system administrators
13
+or anyone who wishes to deploy and operate their own Jitsi Meet instance.
14
+
15
+## User guide
16
+
17
+Work in progress.
18
+
19
+## Developer guide
20
+
21
+### Web
22
+
23
+* [iframe API](https://github.com/jitsi/jitsi-meet/blob/master/doc/api.md)
24
+* [Jitsi Meet development](https://github.com/jitsi/jitsi-meet/blob/master/doc/development.md)
25
+
26
+### Mobile
27
+
28
+* [Building the mobile apps](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile.md)
29
+* [SDK usage examples](https://github.com/jitsi/jitsi-meet-sdk-samples)
30
+* [Enabling Dropbox support](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile-dropbox.md)
31
+* [Enabling Google authentication](https://github.com/jitsi/jitsi-meet/blob/master/doc/mobile-google-auth.md)
32
+
33
+## DevOps guide
34
+
35
+* [Quick install](https://github.com/jitsi/jitsi-meet/blob/master/doc/quick-install.md)
36
+* [Docker install](https://github.com/jitsi/docker-jitsi-meet/blob/master/README.md)
37
+* [Google Calendar, MS Calendar, Dropbox integrations](https://github.com/jitsi/jitsi-meet/blob/master/doc/integrations.md)
38
+* [Video tutorials on deployment and scalability](https://jitsi.org/tutorials/)
39
+* [Configuring a video SIP gateway](https://github.com/jitsi/jitsi-meet/blob/master/doc/sipgw-config.md)
40
+* [Enabling speaker stats](https://github.com/jitsi/jitsi-meet/blob/master/doc/speakerstats-prosody.md)
41
+* [Enabling TURN](https://github.com/jitsi/jitsi-meet/blob/master/doc/turn.md)
42
+* [Networking FAQ](https://github.com/jitsi/jitsi-meet/blob/master/doc/faq.md)
43
+* [Cloud APIs](https://github.com/jitsi/jitsi-meet/blob/master/doc/cloud-api.md)

Завантаження…
Відмінити
Зберегти