Standup: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(fix headers)
(Bot is now called standups instead of standup-irc)
Line 41: Line 41:
Via the irc bot, you just talk to it. For example:
Via the irc bot, you just talk to it. For example:


     standup-irc: Today I wrote a wiki page documenting how standup works.
     standups: Today I wrote a wiki page documenting how standup works.


For syntax help, see the ''Status message formatting'' section later in this wiki page.
For syntax help, see the ''Status message formatting'' section later in this wiki page.
Line 51: Line 51:
You can see if it trusts you by doing this:
You can see if it trusts you by doing this:


     standup-irc: !trust myircnick
     standups: !trust myircnick


where ''myircnick'' is your irc nick.
where ''myircnick'' is your irc nick.
Line 65: Line 65:
You can tell the IRC bot to delete the message:
You can tell the IRC bot to delete the message:


     standup-irc: !delete nnnn
     standups: !delete nnnn


where '''nnnn''' is the Status id number.
where '''nnnn''' is the Status id number.
Line 73: Line 73:
Go to the channel you want to invite the bot into, then invite the bot:
Go to the channel you want to invite the bot into, then invite the bot:


     /invite standup-irc
     /invite standups


=== How to kick the IRC bot out of my project channel ===
=== How to kick the IRC bot out of my project channel ===
Line 79: Line 79:
Tell the bot "bye!":
Tell the bot "bye!":


     standup-irc: !bye
     standups: !bye


=== How to ask the IRC bot for help ===
=== How to ask the IRC bot for help ===
Line 85: Line 85:
You can ask the bot for help using the '''!help''' command:
You can ask the bot for help using the '''!help''' command:


     standup-irc: !help
     standups: !help


It'll reply to you via a direct message with a list of all available commands.
It'll reply to you via a direct message with a list of all available commands.

Revision as of 16:33, 14 December 2016

Summary

Standup is a system for capturing status updates. It is designed to help teams keep each other up to date with what's going on without requiring additional meetings. It can help surface blockers and other issues that impede progress.

Standup consists of a website and an IRC bot on irc.mozilla.org allowing you to post status messages through the website or via the bot on IRC.

Standup has an API allowing anyone to build systems to interact with it. (Note: The API is a work in progress--if you're interested in helping, let us know.)

Standup is an Open Source project. All code is available in the Github repository.

Team

Current Standup admin:

  • pmac: Paul McLanahan
  • willkg: Will Kahn-Greene

Project details

How do I ...?

Create an account

Go to Standup and create an account there.

Post a status message

You can post a status through the web-site or through the irc bot.

Via the website, you need to log in and then post the status using the form.

Via the irc bot, you just talk to it. For example:

   standups: Today I wrote a wiki page documenting how standup works.

For syntax help, see the Status message formatting section later in this wiki page.

How do I get the IRC bot to trust me

The IRC bot only lets you post and do other things if you're registered and authenticated with the IRC server.

You can see if it trusts you by doing this:

   standups: !trust myircnick

where myircnick is your irc nick.

If the IRC bot says "I don't trust myircnick" then that nick hasn't been identified with nickserv during this session.

For irc.mozilla.org, you can register and identify with nickserv using the instructions in the wiki here.

How to get the IRC bot to delete a status update

Sometimes you post an update, then notice that you spelled something wrong or there's a typo in the bug number or you regret ever saying it in the first place or whatever.

You can tell the IRC bot to delete the message:

   standups: !delete nnnn

where nnnn is the Status id number.

How to add the IRC bot to my project channel

Go to the channel you want to invite the bot into, then invite the bot:

   /invite standups

How to kick the IRC bot out of my project channel

Tell the bot "bye!":

   standups: !bye

How to ask the IRC bot for help

You can ask the bot for help using the !help command:

   standups: !help

It'll reply to you via a direct message with a list of all available commands.

Create, manage or remove teams

Standup has the ability to group people and projects into a team. This lets you see the team's status messages which may cross projects and irc channels.

To create, manage and remove teams, contact a Standup admin.

File an issue for a bug or new feature

Go to https://github.com/mozilla/standup/issues and file something there.

Contribute patches, fix bugs, test and so on

Standup is built by you. Development is currently managed in a Github repository.

Status message formatting

Status messages can be formatted roughly using Markdown with some other bits. Here's a key:

markup explanation
#hashtag Just like other social media services, Standup supports hashtags! Some hashtags have special meaning. All hashtags get re-printed at the beginning of your status message.
bug #n and bug n Will link this text to a Mozilla Bugzilla url for the bug.
pull #n and pull n Will link this text to a pull request for the project the status update was posted under.

News and Events

September 23rd, 2016: Pushed out the Standup v2 rewrite

pmac and I rewrote Standup over the course of the last 2 months. Changes:

  1. complete rewrite switching from a Flask app to a Django app with a built-in admin
  2. Persona auth to Github auth
  3. http to https with certification of excellence from httpobs

We're still having some minor teething pains related to bad data in the db which was migrated to a new structure and then subjected to a switch from Persona to Github auth, but things are mostly stable and we're triaging and fixing issues as they come up.

--Willkg (talk) 08:14, 5 October 2016 (PDT)

September 15th, 2016: rogerroger goes away

There were two IRC bots: rogerroger and standups. We decided to have one bot instead of two since that requires less maintenance. Since the name "rogerroger" has connotations we never intended, we're going to ditch that bot and keep standups.

We updated standups with the rogerroger configuration so it is in all the rooms rogerroger was in. On Tuesday, we broadcast a message to everyone that rogerroger was going away and would be replaced by standups and people should tell their friends. On Wednesday, we pushed out a special version of rogerroger that pointed out it was being replaced by standups every time someone used it. That ran for about 24 hours.

Then on Thursday, September 15th, we de-dynoed rogerroger thus removing it from IRC.

Please use the standups IRC bot going forward.

--Willkg (talk) 13:01, 13 September 2016 (PDT)