Skip to content

Commit

Permalink
more fixes and some changed to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tejal29 committed Jun 25, 2021
1 parent fb71380 commit b382f5c
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Use the drop-down labelled `Solo` on the top-right of any page to enable multi-p

NOTE: Multi-player works best if the "Resolution" field of each rule has a clear action to resolve the item and remove it from the list.

## Kanban mode (NEW)
## Kanban mode

![kanban mode](docs/images/kanban.png)

Expand All @@ -141,6 +141,28 @@ Best practices for designing a useful Kanban dashboard:
* If a collection should be displayed in Kanban form by default, specify `display: kanban` in its configuration.
* For velocity measurements and time estimate support, create a rule named `__velocity__` containing recently closed issues to include. See the example configuration.

## Planning Board mode (NEW)
![planning mode](docs/images/planning.png)

In v1.5.0, pages can now be displayed as a SCRUM dashboard.
The columns are based on the feature or Objective(O) the issue belongs to. Use rules to define features.
The rows are swim-lanes based on the target milestones.
To see a real-world example:

* [skaffold planning dashboard](http://tinyurl.com/skaffold-planning)
* [skaffold planning config](https://github.com/google/triage-party/blob/master/config/examples/skaffold.yaml#L142)

In the above example, skaffold has 2 Objectives and 2 features defined
The two objectives are
1) Simply onbaording and make inner devloop faster
2) Extensibility

Best practices for designing a useful Planning dashboard:

* Rules should be designed and ordered in a way that represents progress: `Not started` -> `Started` -> `Under Review` -> `Completed`
* Rules work best when they are mutually excusive (no issue matches multiple rules)
* If a collection should be displayed in Planning form by default, specify `display: planning` in its configuration.

## Data freshness

![age screenshot](docs/images/age.png)
Expand Down
2 changes: 2 additions & 0 deletions pkg/site/planning.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ func getMilestone(c *hubbub.Conversation) string {
return fmt.Sprintf("Milestone: %s", *c.Milestone.Title)
}

// unAssignedOrAvatar is used in a sticky note and hence
// wrapping "unAssigned
func unAssignedOrAvatar(u *provider.User) template.HTML {
if u.GetLogin() == unassigned {
return `🤷`
Expand Down
2 changes: 2 additions & 0 deletions site/collection.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
{{ if ne .Description "" }}
<div class="box description">
<pre>{{ .Description }}</pre>
</div><div class="box description">
<pre>{{ .Description }}</pre>
</div>
{{ end }}

Expand Down
2 changes: 1 addition & 1 deletion site/planning.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@

{{ range .Swimlanes }}
<tr class="swimlane {{ if .Name | isUnplanned }}unassigned-lane{{ end }}">
<td class="kanban-assignee"><a href={{.Url}}>{{ .Name }}</a><div>{{ .Description }}</div></td>
<td class="kanban-assignee"><a href={{.URL}}>{{ .Name }}</a><div>{{ .Description }}</div></td>
{{ range .Columns }}
<td class="kanban-column row">
{{ if . }}
Expand Down

0 comments on commit b382f5c

Please sign in to comment.