From ab49da2d3cc85fc6b098b64027e624bbc9fcf12e Mon Sep 17 00:00:00 2001 From: tejal29 Date: Fri, 25 Jun 2021 09:48:00 -0700 Subject: [PATCH] more fixes --- README.md | 24 +- deploy/kubernetes/configmap.yaml | 455 ++++-------------------------- deploy/kubernetes/deployment.yaml | 2 +- pkg/site/planning.go | 2 +- site/collection.tmpl | 2 + site/planning.tmpl | 2 +- 6 files changed, 85 insertions(+), 402 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/deploy/kubernetes/configmap.yaml b/deploy/kubernetes/configmap.yaml index 7a5ec2b..844949e 100644 --- a/deploy/kubernetes/configmap.yaml +++ b/deploy/kubernetes/configmap.yaml @@ -21,431 +21,90 @@ data: # The contents of config/config.yaml config.yaml: | settings: - name: generic-project - min_similarity: 0.75 + name: skaffold + min_similarity: 0.8 repos: - - https://github.com/photoprism/photoprism + - https://github.com/GoogleContainerTools/skaffold collections: - id: daily name: Daily Triage dedup: false - description: To be emptied out daily - rules: - - issue-needs-comment - - p0-fix-overdue - - p0-followup-overdue - # Don't leave code reviews hanging - - pr-reviewable - # missing initial feedback - - issue-needs-kind - # reprioritize - - issue-new-with-reactions - - issue-new-with-many-commenters - # Don't forget our users - - issue-has-question - - issue-updated-kind-question - - - id: weekly - name: Weekly Triage - dedup: true - description: To be emptied out weekly - rules: - - discuss - # Issues needing reprioritization - - many-reactions - - many-commenters - # Issues needing reprioritization - - issue-zombies - # PR's needing closure - - pr-approved-stale - - pr-unapproved-stale - - birthday - - - id: quarterly - name: Quarterly Scrub - dedup: true - rules: - - question-old - - bugs-old - - enhancement-old - - other-old - - - id: recv - name: "Receive queue" description: > - Issues that may be waiting for our response + Triage-oncall zeroes out this queue once a day. The priorities are: - NOTE: for this to work properly, GitHub token must have read access to read organization members + * Keeping an open dialog with our users + * Initial prioritization (does not have to be perfect) + * SLO compliance rules: - - question-recv - - bugs-recv - - enhancement-recv - - other-recv + # SLO violations + - onboarding - - id: p0 - name: P0 - description: All hands on deck! - rules: - - p0-prs - - p0-features - - p0-bugs - - p0-other + - id: planning + name: Planning + description: > + Skafold Team Planning Board. - - id: p1 - name: P1 - description: To be resolved within 6 weeks - rules: - - p1-prs - - p1-features - - p1-bugs - - p1-other + This board is used by Skaffold team to plan upcoming releases. + The timeline and priority of issues listed here are subject to change. - - id: similar - name: Similar - description: Items which appear similar to one other. Review for duplicates or vague titles. - rules: - - similar-prs - - similar-issues + Please add label planning/Q3-21 for an issue to appear on this board. - - id: open - name: All open PR's and Issues that should be considered for repository stats (hidden) - used_for_statistics: true - hidden: true + display: planning rules: - - open-prs - - open-issues - + - onboarding + - extensibility + - partner-requests + - skaffold-v2 + - docs + - all-other-requests rules: - ### Daily Triage #### - issue-needs-comment: - name: "Unresponded, older than 7 days" - resolution: "Respond to the issue" - type: issue - filters: - - tag: "!commented" - - tag: "recv" - - created: +1w - - # Don't leave code reviews hanging - pr-reviewable: - name: "Pull Requests: Review Ready" - resolution: "Review requests or mark them as do-not-merge/work-in-progress" - type: pull_request - filters: - - label: "!do-not-merge.*" - - label: "!needs-rebase" - - label: "!.*wip" - - label: "!cncf-cla: no" - - tag: "!changes-requested" - - tag: "!send" - - tag: "!commented" - - # Temporarily workaround inability to track PR eligibility - - updated: +1d - - # Issues missing initial feedback - issue-needs-kind: - name: "Unkinded Issues" - resolution: "Add a label" - type: issue - filters: - - label: "!.*(kind|bug|documentation|enhancement|question|todo|idea|epic).*" - - # Issues that may need reprioritized - issue-new-with-reactions: - name: "New, has multiple reactions, but not p0" - resolution: "Check if issue should be prioritized as p0" - type: issue - filters: - - reactions: ">2" - - created: -10d - - tag: "!send" - - label: "!priority/p0" - - issue-new-with-many-commenters: - name: "New, has multiple commenters, but not p0" - resolution: "Check if issue should be prioritized as p0" + ## Planing + onboarding: + name: > + Simple Onboarding, Faster dev. + Use Label - area/onboarding type: issue filters: - - commenters: ">3" - - created: -10d - - tag: "!send" - - label: "!priority/p0" - - # People with questions - issue-updated-kind-question: - name: "question label issue not responded to for over a week" - resolution: "Remove question label, or add a comment" - type: issue - filters: - - tag: recv - - label: ".*question" - - tag: "!member-last" - - tag: "!contributor-last" - - responded: +8d - - issue-has-question: - name: "Reporter asked a question over a week ago" - resolution: "Add an answer" - type: issue - filters: - - tag: recv-q - - tag: "!member-last" - - tag: "!contributor-last" - - responded: +7d - - ####### Weekly Triage ######### - discuss: - name: "Items for discussion" - resolution: "Discuss and remove label" - filters: - - label: ".*discuss" - - state: "all" - - # SLO nearing - p0-followup-overdue: - name: "p0 issue, no comments in 3 days" - resolution: "Downgrade to p1" + - label: "planning/Q3-21" + - label: "area/onboarding" + extensibility: + name: > + Extensibility - Deploy and Lifecyle. + Use Label area/extensibility type: issue filters: - - label: "priority/p0" - - tag: recv - - responded: +3d + - label: "planning/Q3-21" + - label: "area/extensibility" - p0-fix-overdue: - name: "p0 bug, older than 7 days" - resolution: "Downgrade to p1" + skaffold-v2: + name: > + Skaffold V2 pipeline. + Use Label area/V2 type: issue filters: - - label: "priority/p0" - - created: +7d - - # issues needing reprioritization - many-reactions: - name: "many reactions, low priority, no recent comment" - resolution: "Bump the priority, add a comment" - filters: - - reactions: ">3" - - reactions-per-month: ">1" - - label: "!priority/p0" - - label: "!priority/p1" - - responded: +60d - - many-commenters: - name: "many commenters, low priority, no recent comment" - resolution: "Consider increasing priority" - type: issue - filters: - - commenters: ">3" - - commenters-per-month: ">1.9" - - created: "+30d" - - label: "!priority/p0" - - label: "!priority/p1" - - tag: "!member-last" - - responded: "+60d" - - issue-zombies: - name: "Screaming into the void" - resolution: "Reopen, or ask folks to open a new issue" - type: issue - filters: - - state: closed - - comments-while-closed: ">1" - - updated: "-14d" - - tag: "!member-last" - - # Issues needing closure - birthday: - name: "Forgotten Birthdays - over a year old, no response in 6 months" - resolution: "Close or comment on what it would take to address this issue" - filters: - - created: +365d - - responded: +180d - - # PR's needing closure - pr-approved-stale: - name: "Pull requests: Approved and getting old" - type: pull_request - filters: - - label: "!do-not-merge.*" - - label: "!needs-rebase" - - label: "approved" - - updated: +5d - - responded: +2d - - pr-unapproved-stale: - name: "Pull Requests: Stale" - resolution: "Add comment and/or close PR" - type: pull_request - filters: - - created: +20d - - updated: +5d - - responded: +2d + - label: "planning/Q3-21" + - label: "area/extensibility" - ## Bug Scrub ## - question-old: - name: "Questions that have been open for >3 weeks" - resolution: "Comment or close the issue" + partner-requests: + name: > + Other partner requests. + Use Label source/partnerships type: issue filters: - - responded: +7d - - created: +21d - - label: ".*question" + - label: "planning/Q3-21" + - label: "source/partnerships" - enhancement-old: - name: "Features that have been commented on within 90 days" - resolution: "Comment or close the issue" + docs: + name: > + Skaffold Docs. + Use label area/docs type: issue filters: - - responded: +1d - - created: +1d - - label: ".*(feature|enhancement|idea).*" + - label: "planning/Q3-21" + - label: "area/docs" - bugs-old: - name: "Bugs that have not been commented on within 90 days" - resolution: "Comment or close the issue" + all-other-requests: + name: "Others" type: issue filters: - - label: ".*bug.*" - - responded: +1d - - created: +1d - - label: "!priority/awaiting-evidence" - - other-old: - name: "Other items that have not been commented on within 90 days" - resolution: "Comment or close the issue" - type: issue - filters: - - responded: +1d - - created: +1d - - label: "!.*question" - - label: "!.*(feature|enhancement).*" - - label: "!.*bug" - - # Receive queue - question-recv: - name: "Questions awaiting follow-up" - resolution: "Comment or close the issue" - type: issue - filters: - - tag: recv - - label: ".*question" - - bugs-recv: - name: "Bugs awaiting follow-up" - resolution: "Comment or close the issue" - type: issue - filters: - - tag: recv - - label: ".*bug" - - enhancement-recv: - name: "Features awaiting follow-up" - resolution: "Comment or close the issue" - type: issue - filters: - - tag: recv - - label: ".*(feature|enhancement|idea).*" - - other-recv: - name: "Items that deserve a follow-up comment" - resolution: "Comment or close the issue" - type: issue - filters: - - tag: recv - - responded: +30d - - label: "!.*(feature|enhancement).*" - - label: "!.*bug" - - label: ".*question" - - # P0 - p0-features: - name: "p0 Bugs" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p0" - - label: "kind/bug" - - p0-bugs: - name: "p0 Features" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p0" - - label: "kind/feature-request" - - p0-other: - name: "p0 Other" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p0" - - label: "!kind/feature-request" - - label: "!kind/bug" - - p0-prs: - name: "p0 Pull Requests" - type: pull_request - resolution: Merge em - filters: - - label: "priority/p0" - - # P1 - p1-bugs: - name: "p1 Bugs" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p1" - - label: "kind/bug" - - p1-features: - name: "p1 Features" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p1" - - label: "kind/feature-request" - - p1-other: - name: "p1 Other" - type: issue - resolution: Close or deprioritize - filters: - - label: "priority/p1" - - label: "!kind/feature-request" - - label: "!kind/bug" - - p1-prs: - name: "p1 Pull Requests" - type: pull_request - resolution: Merge em - filters: - - label: "priority/p1" - - ## Similar - similar-prs: - name: "Similar Pull Requests" - type: pull_request - resolution: Close as duplicate or give a better title - filters: - - tag: similar - - similar-issues: - name: "Similar Issues" - type: issue - resolution: Close as duplicate or give a better title - filters: - - tag: similar - - # for statistics generation - open-issues: - name: "Open Issues" - type: issue - state: open - - open-prs: - name: "Open PRs" - type: pull_request - state: open + - label: "planning/Q3-21" \ No newline at end of file diff --git a/deploy/kubernetes/deployment.yaml b/deploy/kubernetes/deployment.yaml index 8dfeb86..5730812 100644 --- a/deploy/kubernetes/deployment.yaml +++ b/deploy/kubernetes/deployment.yaml @@ -28,7 +28,7 @@ spec: spec: containers: - name: triage-party - image: triageparty/triage-party + image: tparty imagePullPolicy: Always env: - name: GITHUB_TOKEN diff --git a/pkg/site/planning.go b/pkg/site/planning.go index 162313f..c0bad86 100644 --- a/pkg/site/planning.go +++ b/pkg/site/planning.go @@ -95,7 +95,7 @@ func getMilestone(c *hubbub.Conversation) string { func unAssignedOrAvatar(u *provider.User) template.HTML { if u.GetLogin() == unassigned { - return `🤷` + return `
🤷
` } return avatar(u) } 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 "" }}
{{ .Description }}
+
+
{{ .Description }}
{{ 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 }} - {{ .Name }}
{{ .Description }}
+ {{ .Name }}
{{ .Description }}
{{ range .Columns }} {{ if . }}