Standup: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(first pass at standup page)
 
(bunch of updates and some standup-irc bot examples)
Line 41: Line 41:
You can post a status through the web-site or through the irc bot.
You can post a status through the web-site or through the irc bot.


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


# Log in to [http://standu.ps/ Standup]
Via the irc bot, you just talk to it. For example:
# Post status using the form


Via the irc bot:
    standup-irc: Today I wrote a wiki page documenting how standup works.


# Talk to the bot--see examples later in this document
For syntax help, see the ''Status message formatting'' section later in this wiki page.


=== Status message formatting ===
=== 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:
 
    standup-irc: !delete nnnn
 
where '''nnnn''' is the Status id number.
 
=== How to add the IRC bot to my project channel ===
 
FIXME
 
=== How to kick the IRC bot out of my project channel ===
 
FIXME
 
=== How to ask the IRC bot for help ===
 
You can ask the bot for help using the '''!help''' command:
 
    standup-irc: !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 [https://github.com/mozilla/standup Github repository].
 
== Status message formatting ==


Status messages can be formatted roughly using Markdown with some other bits. Here's a key:
Status messages can be formatted roughly using Markdown with some other bits. Here's a key:
Line 67: Line 106:
|Will link this text to a pull request for the project the status update was posted under.
|Will link this text to a pull request for the project the status update was posted under.
|}
|}
=== 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 [https://github.com/mozilla/standup Github repository].

Revision as of 14:55, 8 September 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.

News

  • September 7th, 2016: Undergoing a rewrite in Django.

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:

   standup-irc: 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 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:

   standup-irc: !delete nnnn

where nnnn is the Status id number.

How to add the IRC bot to my project channel

FIXME

How to kick the IRC bot out of my project channel

FIXME

How to ask the IRC bot for help

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

   standup-irc: !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.