Skip to content
GitLab Next
Closed
Created by Mek Stittri@meksMaintainer

Ally Handbook OKR/KR card embedding

Summary

We want to embed Ally into our handbook. The existing method is a total application render via iFrame which is

  • Unintuitive, and necessarily bells and whistles
  • Not secure
  • Needs to improve on bottomline information presented

We are asking Ally to come up with a simpler and more secure integration via Javascript.

Current handbook usage

Taking an example from https://about.gitlab.com/company/okrs/fy22-q2/#okrs

Screen_Shot_2021-06-08_at_8.25.12_AM

Requirements

  • Single Javascript shows all OKRs for a team
  • One level drill down into KRs (but no further)
  • Attributes
    1. OKR/KR title
    2. Team
    3. Status
    4. Progress
  • Read only visibility
  • Works regardless of logged in status

Screen_Shot_2021-06-08_at_8.11.13_AM_2

2021-07-20

From Ally: We will have a drop for July 23rd where you can try out the embed handbook feature. Please see the linked video on how it works in the product. We are running long on finishing up the scale testing on this as well as more granular permissions, so the video covers the caveats with trying out this initial drop.

Summarizing here:

  • We expect to complete the scale testing early next week, after which you can use the embed on sites that expect a lot of traffic. Please wait till we give the go ahead before embedding on public handbook pages.
  • The permission configuration will be completed by Aug 3rd and will let you set policy on who can generate these embed links.
  • Loom video overview: https://www.loom.com/share/130ad62ec437424682d2e9768b0bbbdd
    • Try on pages for internal testing
    • They are improving caching and want to finish it up early next week
    • Ask is to test on a test page rather than our public site.

Mockups

Lume video https://www.loom.com/share/2dae1bf0f5234df6969ac8d93d0671e0

  • This will be delivered via a "view creation" feature
  • View creation publishes a read-only view into a selected OKR structure
  • Copy-paste ready snippet will be available and guaranteed secure (start with iFrame)
  • We will have the options to select which attributes to show
    • Owner
    • Team
    • First level KR
    • First level projects
    • Status
    • Metric

Screen_Shot_2021-06-23_at_9.05.09_AM

Screen_Shot_2021-06-23_at_9.06.52_AM

Embedding will be driven by 2 views types

  1. Preset views - useful to track current status/snapshot:
    • Active Quarter
    • Upcoming Quarter
    • Previous Quarter
    • Needs Attention
  2. Custom views - can be filtered to any of:
    • Time period
    • Type
    • Owner
    • Status
Presets and custom views
Screen_Shot_2021-07-12_at_2.32.34_PM
Filter on an existing view and save to create a custom view
Screen_Shot_2021-07-12_at_1.39.40_PM
Screen_Shot_2021-07-12_at_1.39.53_PM
Screen_Shot_2021-07-12_at_1.40.05_PM

Creating an Embeddable view

  • Once desire view is created/present, proceed to Share dropdown
  • Go to Embedded option
  • A review link is available
  • Be default the options are preselected but can be customized at this step
  • Design is also responsive on a best-case-to-fit basis
Filter on an existing view and save to create a custom view
Screen_Shot_2021-07-12_at_1.34.29_PM
Screen_Shot_2021-07-12_at_1.35.07_PM
Screen_Shot_2021-07-12_at_1.35.27_PM_2
Screen_Shot_2021-07-12_at_1.37.10_PM
Screen_Shot_2021-07-12_at_1.35.27_PM
Screen_Shot_2021-07-12_at_1.35.51_PM
Screen_Shot_2021-07-12_at_1.38.38_PM

Rollout

Ally has enabled a new feature that allows us to embed OKRs to our handbook. Instructions have been added to our handbook with a video overview.

One key change (also mentioned in the video) the OKR period is now a dropdown on the left-hand side. This was on the right prior. The embedding function is through the option next to this dropdown. You can see an example MR and team handbook page here:

Edited by Mek Stittri