All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Microsoft AD integration
- Removed user request logic
- All new users are automatically created in the database when signing in with Microsoft AD
- New API endpoints - getting the audit log
- Possible to add team members to organizations and departments
- Sort organizations by name
- Small style fixes
- Correct modal size
- Removed svg-loader - Icons were not showing correctly for some users
- Fixed SiteHeader not showing correct Prod/Dep/Org-name when doing changes to KPIs/OKRs
- Small fixes to components not using the correct color-styles
We are looking at doing some design changes to the Objective/KeyRes-view, which means that some changes need to be made beforehand. We have therefore implemented a Theme Toggle! You can now toggle between Blue, Yellow and Green color themes.
- (Beta) Theme Toggle: toggle between Blue, Green or Yellow color themes
- Switch color theme at the bottom of the sidebar or in the user-menu in the top right corner
- Updated dependencies
- ItemAdmin(org/dep/prod): Update failed if API Secret was empty
- Updated dependencies
- Added a security UUID for each team that needs to be sent with the api-call if you want to update KPI/KeyRes for better security.
- Go to your Org/Dep/Product and add a secret under
API Secret-input
- Go to your Org/Dep/Product and add a secret under
- KPI: Show curl-example after adding a new KPI and toggled on updated via API
- Key Result: Show curl-example if you toggle the option "update via API"
- CF/API: better logging with express middleware morgan
- KeyRes-Graph: if target value is higher than the current value, then expand the y-axis to not go under the x-axis or over the top of the y-axis
- KPIHome: format all values to correct format. Instead of floats -> format to percentage
- Better OpenSpec and API-gateway support.
- Moved API-KEY for Gateway from query-param to header
- CF/API: save progress (KPI/KeyRes) as a number and not a string
- CF/API: Fixed a bug with the KeyRes GET return two responses on the same GET-call which caused the API to crash
- Cloud Functions: CRUD API for KPI and Key Results. It is now possible to call an end point if you want to update progress through the API and not through the frontend. Locked behind API Gateway with API key, get in contact to get a key.
- API Gateway: added gateway for users to call if they want access to API for KPI and Key Results. Needs API Key from us, contact us to get a key for your own team
- Swagger doc: read more about the new open API end points at https://okr.oslo.systems/api
- Disable KPI auto update functionality if you would rather update through the API yourself
- Updated dependencies
- Key result progress "registered by" never showed anything if it was registered automatically by Cloud Functions
OKR-tracker will get out of beta/RC by the end of June 2021. It has been in a beta-state for quite some time now, and we feel it has matured enough for a full release. This does not mean we will stop working on it, since we do have some milestones we would like to hit.
- Remove all client side db-changes. Move everything to a Cloud Function, in that way we can set up a more normal API CRUD backend and not rely on the client db-access.
- Most importantly: refactor RBAC - add different roles with different accesses
- Cloud Function: CRUD API for requestAccess and creation of user
- Drop node-sass support
- Add dart-sass support
- Dev-environment for users outside of Oslo kommune to test our application before forking/using
- Show User UID in profile
- Custom personalized sign in text for the keycloak sign-in button (default is
Sign in with keycloak, new environment variable)
- Firestore rules: KeyRes were only allowed for uid-objects and not email-objects
- Service account private key is not optional - it is required to add the private key json-file to firebase functions config (check out the README)
- Changes to environment variables - please read the README
- Dropped support for Node < 14.x
- Required Node >= 14.x
- Keycloak integration: sign in using keycloak and use the keycloak token to create a custom token for firebase
- Keycloak integration
- Functions: tokenCreator - create custom tokens for custom auth integration with firebase
- LoadingSmall-component: a loading-animation that is smaller than the normal one
- Logout page: user is redirected here if there is a problem with signing in
- Store new unique id's to user-object for later migration to uid-control
- Alert-components
- firestore-rules: Not allowed to read the user-objects without being signed in
- Better support to handling errors or if user does not have access to a resource
- Design of login page
- Support for Node < 14.x
- Drop IE 11 support
- Meta-tags for fb/twitter/open graph
- robots.txt
- Line chart should handle higher values even if it is higher than target value
- Cron job changes to scheduled cloud functions
- Set time zone to Europe/Oslo for scheduled cloud functions
- Updated dependencies
- Show all comments in progression list for a key result
- Loading loop when trying to access site without credentials
- Automated key results not actually running automatically (cron job set to once a day)
- Line graph handling numbers >100k
- Progression not updating when archiving key results
- Give cloud functions more memory and a longer timeout
- Better filter support in details page of a kpi
- Collapse rows of organizations and departments on the front page - save to user objects (everyone starts with collapsed)
- Search through items in the admin panel - if there are over 15 items respectively
- KeyResult: allow target value to be 0
- Allow decimals on inputs
- Show team members even though a period is not present
- Items in the admin panel are sorted by name
- Departments and products are sorted by name in ASC order
- Small change to KPI for users - no number formatting when in ItemHome-view only in Home-view
- Updated dependencies
- Typo in cloud function code for KPIs
- Call cloud function in correct region - change from central1 to europe-west2
- Updated dependencies
- Access to Team Drives for service accounts (if strict domain policy is enabled)
- Better explanation about the Google Sheets information when adding KPIs
- Objectives/KeyResults are ordered alphabetically
- Updated dependencies
- Updated firestore indexes
- Admin OKRs component - No need to fetch data every single time
- Updated dependencies
- Components in admin-okr not updating correctly
- Information about enabling Google Sheets API
- Allow use of decimal-numbers
- vue-resize is not used
- Unused css-styles
- Updated Firebase to 8.1.2
- More consistent BEM-naming
- Updated dependencies
- Updated firebase storage rules to v2
- Filter KPI-progression
- E2E-tests (alpha)
- Updated the design of
KpiHome.vue - Moved duplicate css-code to global
- Renamed html-tags to kebab-case
- Minor improvements to the code
- Updated prettier-config
arrowParensfromavoidtoalways
- English locale
- Store language preference on user
- Change language preference on profile page
- Markdown support on mission statements and key result notes
- Force order of KPIs + include non-existent KPIs on ItemHome
- Fix issue with findSlugAndRedirect-method - returns redirect and increased delay
- Add defaultPreferences on user if not existing (simplifies mock data creation)
- Remove misplaced markup on objective details widget
- Add missing translations
- Replaced 'deleted' with 'archived' in toaster
- Automatically archives related objectives and key results when archiving periods and objectives
- Improved Google Sheets integration guide on help page
- Display startValue if no currentValue is set on key result home view
Several breaking changes. See release notes.
- MIT License
- Improve documentation
- Fix issue regarding saving
longDescriptionfor key results
- Description-field for key-result. Ref. issue #106.
- Upgrade dependencies
- User-search: sum of weighted keys is not allowed to exceed 1
- Typo in nb-no translation
- Objective-progression was always 0
- Products did not update accordingly when changing routes
- keyResultPage did not show longDescription correctly
- Dynamic
<title>s withvue-meta - Ability to add comments when updating progress for a key result via toaster
- Display comments as tooltips on progressions list for a key result
- Fuzzy search for user list on admin panel with
Fuse.js
- Increase modal size for members chart
- Sortable columns for user list on admin panel
- Layout issue on key result page on certain page widths
- A few locale strings that were not mapped correctly
- Remove random word space before 'Home' in breadcrumbs
- Fix issue where progression for an empty objective shows as 'NaN'
- Fix z-index issue with the members modal
- Removed padding around force graph
- Better handling of responsive sizes for force graph
- Visualising members of a department as a network graph
- Localization for nb-no with vue-i18n
- Refactor all Cloud Functions
- Better documentation (jsdoc) for all Cloud Functions
- Show progress next to an objective also when it's empty (0%)
- Fix bug where progression for objectives and periods did not get updated when a new (empty) key result was created
- Hide dashboard view for departments and organisations
- Fix error logged when toggling archived documents on admin panel
OKRs are now supported on organisation level. This will allow administrators to create and manage details (name, mission statement), objectives and key results for organisations.
Organisations will work in a similar fashion as departments and products, whereas the child departments will be displayed on an organisation’s page. Please note that creating and/or deleting organisations is not included in this version.
- OKRs for organisation level
- Character limits for user inputs
- OKRs for organisation level
- Edit existing organisations from the admin panel
- Page to view organisations under route
/organization/<slug> - Manage objectives and key results for organisation at
/organization/<slug>/edit - Cloud functions to handle progression for organisation
- Supporting Markdown for mission statements
- Convert the organisation in breadcrumbs to a link
- Use
placeholder-image.svginstead ofplaceholder-user.svgfor departments and products that do not have an image - Consistently use American
organizationinstead oforganisationas function and variable names - Reduce font weight on table of contents on help page
- Limit character count on various user inputs
profile/displayName<= 32 charorganization/name<= 64 chardepartment/name<= 64 charproduct/name<= 64 charperiod/name<= 12 charobjective/description<= 320 charobjective/name<= 160 charmissionStatement<= 320 charkeyResult/description<= 120 charkeyResult/unit<= 32 char
- Improved design on members and products lists (include name next to its image)
- Improved content on
help.md- Managing products
- Managing organisations
- Managing dynamic periods
- Reduce size of image preview on forms for editing organisations, departments and products
- Visualise the (positive or negative) change on the newsfeed card for updating progress on a key result
Migrating data from Google Sheets: Functionality for migrating data from Google Sheets should no longer be necessary. The scripts for handling this will remain in the codebase for now, but will soon be removed. The description and file upload will be removed in the UI.
- Form for migrating data from Google Sheets
- Fix JSDoc errors in
db.js
This release introduces dynamic date periods that replace static annual quarters for objectives. This means that custom date periods need to be manually created on each department and product onwards.
Under the ‘Danger Zone’ section on the admin view there is an action that automates the convertion of currently existing objecties onto dyamic date periods. This should only be triggered once in production after release of this version to prevent data loss.
This change adds a /periods subcollection on the departments and products collections that holds the details for the periods as well as the progression for that period.
- Show callout to team members when a product image is missing
- Documentation for managing departments on Help page
- Automated backup of the firebase database
- Automated restore of backup for the firebase database
- Converting static annual quarters to dynamic and custom date periods
- Users can now create unlimited future (and past) periods
- Users must give name date periods
- Navigating between periods using URL query parameters
- Adjustments in Cloud Functions to handle progression for dynamic periods
- Refactoring some Firestore handling – introducing the
serializeListfunction to make the codebase a bit more DRY. - Hide progress visualisation when department or product does not have any objectives
- Legacy dashboard component
- Fix issue where progress graphic did not always update when navigating between pages
- Force the submenu to appear even when no periods are available
- Minor layout adjustment on the page header (less white space below page name on desktop)
- Allow floating point numbers as key result progress
- Replace ninjas with cubes when a department has zero products
- Upgrade dependencies
- Table of contents on help page
- CHANGELOG.md
- Fixed misleading text on help page for updating profile image
- Hide notes on key result page for non-members
- Improve styling of line chart (gradient fill)
- Increase size and quality for uploaded images
- Updated event-types.md with correct data
- Navigating to products/departments didn’t load the correct data
- Updating/changing a migrated key results
First official release.