diff --git a/documentation/user.md b/documentation/user.md index fdca6598..f069fc46 100644 --- a/documentation/user.md +++ b/documentation/user.md @@ -17,6 +17,7 @@ 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](user_slack/register.html) -* [Connecting Slack channels with 3rd-party rooms](user_slack/connecting_channels.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) diff --git a/documentation/user_slack/interconnecting_channels.md b/documentation/user_slack/interconnecting_channels.md new file mode 100644 index 00000000..b5ff0a47 --- /dev/null +++ b/documentation/user_slack/interconnecting_channels.md @@ -0,0 +1,22 @@ +--- +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 new file mode 100644 index 00000000..46476274 --- /dev/null +++ b/documentation/user_slack/register.md @@ -0,0 +1,27 @@ +--- +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 new file mode 100644 index 00000000..0fa6031a --- /dev/null +++ b/documentation/user_slack/slack_commands.md @@ -0,0 +1,18 @@ +--- +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.