diff --git a/documentation/admin.md b/documentation/admin.md deleted file mode 100644 index bfe59f24..00000000 --- a/documentation/admin.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: page -title: Spectrum 2 ---- - -This is Admin documentation for Spectrum 2 transport. If you are user trying to use Spectrum 2, you should switch to [User documentation](user.html). - -#### About - -* [What is Spectrum 2?](about.html) - -#### Installation - -* [Installing using Docker](installation/docker.html) -* [Installing on Debian/Ubuntu](installation/packages_debian_ubuntu.html) -* [Installing from source code](installation/from_source_code.html) - -#### Frontends - -* [Frontends overview](frontends/frontends.html) -* [XMPP Frontend](frontends/xmpp.html) - * [Using SSL in server mode](configuration/server_ssl.html) - * [Spectrum 2 as bouncer](configuration/bouncer.html) -* [Slack Frontend](frontends/slack.html) - -#### Backends - -* [Backends overview](backends/backends.html) -* [Libpurple backend](backends/libpurple.html) -* [Libcommuni backend](backends/libcommuni.html) -* [Twitter backend](backends/twitter.html) -* [Transwhat backend](backends/transwhat.html) - -#### Tutorials - -* [XMPP Frontend](frontends/xmpp.html) - * [Spectrum 2 in gateway mode](tutorials/gateway_mode.html) - * [Beginners guide (prosody + spectrum2 + twitter backend)](tutorials/beginners_guide.html) - -#### Configuration - -* [Configuration file description](configuration/config_file.html) -* [MySQL Support](configuration/mysql.html) -* [PostgreSQL Support](configuration/postgresql.html) -* [Logging](configuration/logging.html) -* [Web storage](configuration/web_storage.html) - -#### Management - -* [spectrum2_manager tool](management/spectrum2_manager.html) -* [Web Interface](management/web_interface.html) -* [Getting a backtrace](management/getting_backtrace.html) -* [Munin integration](management/munin.html) - -#### Development - -* [Spectrum 2 architecture](development/architecture.html) -* [Writing backend in any language (or How the backend works inside)](development/protocol.html) diff --git a/documentation/index.md b/documentation/index.md index d6379fff..ad6eb9e5 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -3,22 +3,54 @@ layout: page title: Spectrum 2 --- -## Documentation +#### About -
-

User documentation

-
-This part of documentation is created for Spectrum 2 end users. It documents how to use the Spectrum 2 from user perspective. -
-Read More -
+* [What is Spectrum 2?](about.html) -
-

Admin documentation

-
-This part of documentation is created for Spectrum 2 administrator. It documents how to setup, configure and manage Spectrum 2 on your own server. -Read More +#### Installation -
+* [Installing using Docker](installation/docker.html) +* [Installing on Debian/Ubuntu](installation/packages_debian_ubuntu.html) +* [Installing from source code](installation/from_source_code.html) -
+#### Frontends + +* [Frontends overview](frontends/frontends.html) +* [XMPP Frontend](frontends/xmpp.html) + * [Using SSL in server mode](configuration/server_ssl.html) + * [Spectrum 2 as bouncer](configuration/bouncer.html) +* [Slack Frontend](frontends/slack.html) + +#### Backends + +* [Backends overview](backends/backends.html) +* [Libpurple backend](backends/libpurple.html) +* [Libcommuni backend](backends/libcommuni.html) +* [Twitter backend](backends/twitter.html) +* [Transwhat backend](backends/transwhat.html) + +#### Tutorials + +* [XMPP Frontend](frontends/xmpp.html) + * [Spectrum 2 in gateway mode](tutorials/gateway_mode.html) + * [Beginners guide (prosody + spectrum2 + twitter backend)](tutorials/beginners_guide.html) + +#### Configuration + +* [Configuration file description](configuration/config_file.html) +* [MySQL Support](configuration/mysql.html) +* [PostgreSQL Support](configuration/postgresql.html) +* [Logging](configuration/logging.html) +* [Web storage](configuration/web_storage.html) + +#### Management + +* [spectrum2_manager tool](management/spectrum2_manager.html) +* [Web Interface](management/web_interface.html) +* [Getting a backtrace](management/getting_backtrace.html) +* [Munin integration](management/munin.html) + +#### Development + +* [Spectrum 2 architecture](development/architecture.html) +* [Writing backend in any language (or How the backend works inside)](development/protocol.html) diff --git a/documentation/user.md b/documentation/user.md deleted file mode 100644 index a6efaa95..00000000 --- a/documentation/user.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: page -title: Spectrum 2 ---- - -This is User documentation for Spectrum 2 transport. If you are administrator trying to configure Spectrum 2 on your server, you should switch to [Admin documentation](admin.html). - -#### About - -* [What is Spectrum 2?](about.html) - - - - - - -#### Using as Slack user - -* [How does Spectrum 2 interact with my team?](user_slack/workflow.html) -* [Our Privacy Policy](user_slack/privacy.html) -* [Adding Spectrum 2 transport to the team](user_slack/add.html)