From b382f5c2be3d652ce332783ae8112b49fd65b6f8 Mon Sep 17 00:00:00 2001
From: tejal29 <tejal29@gmail.com>
Date: Fri, 25 Jun 2021 11:59:28 -0700
Subject: [PATCH] more fixes and some changed to README

---
 README.md            | 24 +++++++++++++++++++++++-
 pkg/site/planning.go |  2 ++
 site/collection.tmpl |  2 ++
 site/planning.tmpl   |  2 +-
 4 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2454e14..669bca9 100644
--- a/README.md
+++ b/README.md
@@ -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)
 
@@ -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)
diff --git a/pkg/site/planning.go b/pkg/site/planning.go
index 162313f..60f410c 100644
--- a/pkg/site/planning.go
+++ b/pkg/site/planning.go
@@ -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 `🤷`
diff --git a/site/collection.tmpl b/site/collection.tmpl
index cf55e3a..0882f67 100644
--- a/site/collection.tmpl
+++ b/site/collection.tmpl
@@ -66,6 +66,8 @@
     {{ if ne .Description "" }}
       <div class="box description">
       <pre>{{ .Description }}</pre>
+      </div><div class="box description">
+      <pre>{{ .Description }}</pre>
       </div>
     {{ end }}
 
diff --git a/site/planning.tmpl b/site/planning.tmpl
index 53dff69..9f1393a 100644
--- a/site/planning.tmpl
+++ b/site/planning.tmpl
@@ -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 . }}