From 4bbea3b730d09661afe681cda4a495777e8cbb98 2016-02-09 21:44:32 From: Jan Kaluza Date: 2016-02-09 21:44:32 Subject: [PATCH] Rewrite Slack user documentation --- diff --git a/documentation/user.md b/documentation/user.md index f069fc46dbb4b63cd0ecdf6a1057bdf6d73aa488..ed57a98985f18da21b506acc2389889dbf4de168 100644 --- a/documentation/user.md +++ b/documentation/user.md @@ -17,7 +17,4 @@ This is User documentation for Spectrum 2 transport. If you are administrator tr #### Using as Slack user * [How does Spectrum 2 interact with my team?](user_slack/workflow.html) -* [Adding Spectrum 2 transport to the team](http://slack.spectrum.im/) -* [Registering with 3rd-party network account](user_slack/register.html) -* [Interonnecting Slack channels with 3rd-party rooms](user_slack/interconnecting_channels.html) -* [List of Spectrum 2 Slack commands](user_slack/slack_commands.html) +* [Adding Spectrum 2 transport to the team](https://slack.spectrum.im/) diff --git a/documentation/user_slack/interconnecting_channels.md b/documentation/user_slack/interconnecting_channels.md deleted file mode 100644 index b5ff0a4721185c43816441acb2f569141c8d82a8..0000000000000000000000000000000000000000 --- a/documentation/user_slack/interconnecting_channels.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: Spectrum 2 ---- - - - -## Interonnecting Slack channels with 3rd-party rooms - -Once you have [registered with 3rd-party network account](user_slack/register.html) (or if you are using IRC), you can also configure interconnection between Slack channel and 3rd-party network room. - -The primary team owner can do it by sending following command to Spectrum 2 bot: - - .spectrum2 join.room NameOfYourBotIn3rdPartyNetwork #3rdPartyRoom hostname_of_3rd_party_server #SlackChannel - -For example to join #test123 channel on Freenode IRC server as MyBot and transport it into #slack_channel, the command would look like this: - - .spectrum2 join.room MyBot #test123 adams.freenode.net #slack_channel - -Another example to join Jabber room spectrum@conference.spectrum.im as SlackBot and transport it to #spectrum_muc Slack channel: - - .spectrum2 join.room SlackBot spectrum conference.spectrum.im #spectrum_muc diff --git a/documentation/user_slack/register.md b/documentation/user_slack/register.md deleted file mode 100644 index 464762740113880183b9b9c14685bae74aa3afc5..0000000000000000000000000000000000000000 --- a/documentation/user_slack/register.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: page -title: Spectrum 2 ---- - - - -## Registering with 3rd-party network account - -Once you have [added Spectrum 2 transport to your team](http://slack.spectrum.im/), Spectrum 2 bot should contact you with instructions how to register with 3rd-party network. This document only sums up the instructions from the Spectrum 2 bot message and in some case documents them further. Note that these steps are not needed for interconnecting with IRC network, because it does not need registrationg. You can skip these instructions in this case. - -All those steps have to be done by the primary team owner. - - -#### 1. Create channel for the 3rd-party network contact list - -As described in the [How does Spectrum 2 interact with my team?](user_slack/workflow.html) document, Spectrum 2 needs a channel where the messages sent to the 3rd-party network account will be forwaded. You therefore have to create a new Slack channel in your team and invite Spectrum 2 bot there. - -#### 2. Register Spectrum 2 with the 3rd-party network - -You have to have 3rd-party account ready and have to know the password for that account to be able to configure Spectrum 2 further. The the primary team owner can send following message to Spectrum 2 bot to register the 3rd-party network account: - - .spectrum2 register 3rdPartyAccount 3rdPartyPassword #SlackChannel - -Example for Jabber: - - .spectrum2 register test@xmpp.tld mypassword #slack_channel diff --git a/documentation/user_slack/slack_commands.md b/documentation/user_slack/slack_commands.md deleted file mode 100644 index 0fa6031a39d14fce2d192574f1c2aa5b24923ff3..0000000000000000000000000000000000000000 --- a/documentation/user_slack/slack_commands.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: Spectrum 2 ---- - - - -## List of Spectrum 2 Slack commands - -The primary team owner can use following commands to configure Spectrum 2 in your team: - -Command|Description ---------|----------- -```.spectrum2 help``` | Shows this help message. -```.spectrum2 join.room <3rdPartyBotName> <#3rdPartyRoom> <3rdPartyServer> <#SlackChannel>``` | Starts transport between 3rd-party room and Slack channel. -```.spectrum2 leave.room <#SlackChannel>``` | Leaves the 3rd-party room connected with the given Slack channel. -```.spectrum2 list.rooms``` | List all the transported rooms. -```.spectrum2 register <3rdPartyNetworkAccount> <3rdPartyPassword> <#SlackChannel>``` | Registers 3rd-party account for transportation. diff --git a/documentation/user_slack/workflow.md b/documentation/user_slack/workflow.md index 4af9229f1a064edee0b37bb8430f7b1d05bc728c..ce1d549a3200e313f230fab2afeeefc0f207be44 100644 --- a/documentation/user_slack/workflow.md +++ b/documentation/user_slack/workflow.md @@ -11,11 +11,8 @@ Spectrum 2 interconnects the Slack channels with the 3rd-party network contact l ![Spectrum 2 Slack workflow](workflow.png) -Spectrum 2 distinguishes between two Slack team members roles: +Slack team members are able to write to channels and their messages are forwaded to 3rd-party network. -* **The primary team owner** is able to configure interconnections between Slack channels and 3rd-party network channels and is also able to configure Spectrum 2 itself. -* **Other Slack team members** are able to write to channels and their messages are forwaded to 3rd-party network. +For networks which have the contact list (like Skype, Jabber or Twitter), there is special mapping between single Slack channel and the contact list. In the image, that channel is called **#MainSlackChannel**. The name of this channel is configured when registering Spectrum 2 instance to Slack team. Whatever is written to the channel is sent to all people in the 3rd-party network contact list and when some of the 3rd-party contacts write an answer, it is forwarded to this Slack channel. -For networks which have the contact list (like Skype, Jabber or Twitter), there is special mapping between single Slack channel and the contact list. In the image, that channel is called **#MainSlackChannel**. The name of this channel is configured by the Primary team owner. Whatever is written to the channel is sent to all people in the 3rd-party network contact list and when some of the 3rd-party contacts write an answer, it is forwarded to this Slack channel. - -For networks which support rooms (like Jabber or IRC), the Primary team owner can configure the interconnection between the 3rd-party room and Slack channel. Whatever is written to that Slack channel is forwarded to the 3rd-party room and vice-versa. +For networks which support rooms (like Jabber or IRC), the Spectrum 2 administrator can configure the interconnection between the 3rd-party room and Slack channel. Whatever is written to that Slack channel is forwarded to the 3rd-party room and vice-versa.