Merge pull request #2924 from objectcomputing/develop

Update release branch from develop

Author: mkimberlin

.github/workflows/gradle-build-feature.yml

@@ -8,6 +8,8 @@ on:
       - 'doc-**/*'
       - 'hotfix-**/*'
       - 'dependabot/**/*'
+env:
+  HUSKY: 0
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/gradle-build-native-feature.yml

@@ -8,6 +8,8 @@ on:
       - 'doc-**/*'
       - 'hotfix-**/*'
       - 'dependabot/**/*'
+env:
+  HUSKY: 0
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/gradle-build-production.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - "master"
 env:
+  HUSKY: 0
   PROJECT_ID: ${{ secrets.RUN_PROJECT }}
   RUN_REGION: us-central1
   SERVICE_NAME: checkins-master

.github/workflows/gradle-build-publish.yml

@@ -2,6 +2,8 @@ name: Gradle Publish to GitHub Packages
 on:
   release:
     types: [created]
+env:
+  HUSKY: 0
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/gradle-dependency-submission.yml

@@ -3,7 +3,8 @@ name: Gradle Dependency Submission
 on:
   push:
     branches: [ 'develop', 'master', 'feature-2532/graal' ]
-
+env:
+  HUSKY: 0
 permissions:
   contents: write
 

.github/workflows/gradle-deploy-develop.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - 'develop'
 env:
+  HUSKY: 0
   PROJECT_ID: ${{ secrets.RUN_PROJECT }}
   RUN_REGION: us-central1
   SERVICE_NAME: checkins-develop

.github/workflows/gradle-deploy-native-develop.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - 'develop'
 env:
+  HUSKY: 0
   PROJECT_ID: ${{ secrets.RUN_PROJECT }}
   RUN_REGION: us-central1
   SERVICE_NAME: checkins-develop-native

.github/workflows/jekyll.yml

@@ -10,6 +10,8 @@ on:
   # Runs on pushes targeting the default branch
   push:
     branches: [develop]
+env:
+  HUSKY: 0
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

README.md

@@ -1,38 +1,77 @@
-[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-build-develop.yml)
+# Check-Ins
+
+Check-Ins is a team engagement platform with [many HRIS and engagement capabilities](#features) built on
+[Micronaut](https://micronaut.io/) and [React](https://react.dev/) and available for deployment on premises or on
+[Google Cloud Platform](https://cloud.google.com/).
+
+[![Gradle Build & Deploy - Develop](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-deploy-develop.yml/badge.svg)](https://github.com/objectcomputing/check-ins/actions/workflows/gradle-deploy-develop.yml)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 <!-- TOC -->
+## Table of Contents
 
-- [Check-ins](#check-ins)
-- [Project Links](#project-links)
-- [Setup](#setup)
-  - [directory.json](#directoryjson)
-  - [credentials.json](#credentialsjson)
-  - [Running the application](#running-the-application)
+- [About](#about)
+- [Features](#features)
+- [Documentation](#documentation)
+- [Getting Started](#getting-started)
+  - [Environment Setup](#environment-setup)
+  - [Running the Application](#running-the-application)
+  - [Troubleshooting](#troubleshooting)
 - [Contributing](#contributing)
-
+- [License](#license)
+- [Contact](#contact)
 <!-- /TOC -->
 
-# Check-ins
+## About
+
+Check-Ins is a comprehensive web application designed to streamline team management and personal development. It offers
+tools for understanding team members and their capabilities, facilitating growth and engagement, and managing many of
+the processes that can get dropped or weigh down an organization. Built with Micronaut, Check-Ins is designed for
+efficient cost of operation and ease of use. Many of the workflows were originally designed and built by former interns
+at [Object Computing](https://objectcomputing.com), and we use it actively there today.
+
+## Features
 
-This web application is written in [Micronaut](https://micronaut.io) for uploading files and tracking skill set of team members. This application will also be used for PDL checkins and to auto-generate resumes from the skill set.
+- **User/Employee Management** - Simple onboarding and offboarding of new users, with Google SSO integration
+- **Employee Profiles** - Team members can manage their own profiles, including skills, certifications, and organizations they support 
+- **Mentor Program Management** - A key feature of the Check-Ins application is the support and management of employee touch points with a dedicated mentor
+- **Pulse Surveys** - Find out how your team is feeling about work, or life in general
+- **Feedback Management** - Give your employees access to feedback so that they can grow their skills and contribute up to their potential
+- **Employee, Team, and Community Directories** - These provide an easy way to see who is involved with what 
+- **Performance Reviews and Reporting** - Evaluate your team's performance as frequently as you would like
+- **Public Kudos** - Celebrate those wins publicly! Our Kudos feature can post your team's wins to Slack and celebrate them within the application.
+- **Birthday and Anniversary Celebrations** - Encourage the celebration of your team's milestones
+- **Skill and Certification Tracking and Reporting** - Know where your team is strong, where it needs to develop, and plan for growth
+- **Volunteer Time Tracking and Reporting** - Encourage a culture of giving back to your community by recognizing the good work already being done by your team
 
-# Project Links
+## Documentation
 
-**Project Document:** \*TBA\*
+Detailed documentation, including installation guides, usage instructions, and API references, can be found on our [GitHub Pages site](https://objectcomputing.github.io/check-ins/).
 
-**Project Board:** [Board](https://github.com/objectcomputing/check-ins/projects)
+## Getting Started
 
-**Environments:** \*TBA\*
+### Environment setup
 
-# Environment setup
+See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment.
 
-See [Setting up your environment](https://objectcomputing.github.io/check-ins/getting-started/setup/) for instructions on setting up your development environment.
+### Running the application
 
-## Running the application
+See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally.
 
-See [Running the Application](https://objectcomputing.github.io/check-ins/getting-started/running/) for instructions on running the application locally.
+### Troubleshooting
 
-# Contributing
+See [our GitHub pages site](https://objectcomputing.github.io/check-ins/getting-started/troubleshooting/) for common challenges and their solutions.
+
+## Contributing
 
 Please see [Contributing](./CONTRIBUTING.md) for details on how to contribute to this project.
+
+## License
+
+This project is licensed under the [Apache 2.0 License and Commons Clause](LICENSE).
+
+## Contact
+
+For questions or issues, please [join the discussion](https://github.com/objectcomputing/check-ins/discussions) or
+[open an issue](https://github.com/objectcomputing/check-ins/issues) on GitHub.

docs/project-roadmap/index.md

@@ -6,70 +6,64 @@ title: Project Roadmap
 
 ***This roadmap is subject to change and should not be construed as a commitment to build these features.***
 
-This roadmap prioritizes features focused on enhancing the team member review process, integrating the shelved onboarding process, and incorporating generative AI for mentor support.
+This roadmap prioritizes features focused on enhancing team member and mentor support, white labeling the application,
+and preparing it for deployment into multiple environment types.
 
-## Streamlined and Repeatable Reviews (0.8.0)
+## Release Clean Up (v0.8.x)
 
-1. **Review Planning & Validation:**
-    * Implement a dedicated review planning phase.
-    * Automatically assign reviewers and validate assignments with managers.
-    * Enable multi-layered team review structures:
-        * Managers review planned assignments for subordinate managers.
-        * Subordinate managers incorporate suggestions before final approval.
-    * Integrate timeline creation and review launch functionalities for administrators.
-2. **Review Implementation:**
-    * Streamline self-reviews and manager reviews.
-    * Introduce automated reminders to both managers and team members.
-    * Provide automated status overview emails to administrators.
-    * Provide relevant contextual information during reviews, including:
-        * Current title and job description
-        * Skills listed in user profiles
-        * Feedback received previously
-3. **Reporting:**
-    * Develop review process reports detailing completion rates (breakdowns by department, etc.).
-    * Create manager reports that detail individual and aggregate review outcomes.
+- [x] Documentation Updates
+- [x] Other Dependency Upgrades and Security Alert Remediation
+- [ ] Bug Smooshing and Tech Debt Remediation
 
-### Success Metrics:
+## Configuration UI and Infrastructure Codification (v0.9.0)
 
-* Increased on-time completion rates for employee reviews
-* Increased on-time review period start rates
-* Improved user satisfaction with the review process
+1. **Introduce Infrastructure as Code**
+   - Create Terraform code for
+        - [ ] Local Deployment
+        - [ ] GCP Deployment
+        - [ ] AWS Deployment (stretch-goal)
+   - [ ] Migrate to cloud-based secret management
+2. **Configuration Management UI**
+    - [ ] Implement feature switches
+    - [ ] Move most configuration into the UI and store in the database
 
-## Onboarding and Modernization (0.9.0)
+### Goals (v0.9.0)
 
-1. **Modularize Deployment:**
-   * Upgrade to Micronaut 4.x.
-   * Introduce infrastructure as code.
-      * Codify GCP environments with Terraform.
-      * Migrate to cloud-based secret management.
-   * Segment service deployments.
-2. **Revive Onboarding Application:**
-    * Rebase and refresh the onboarding application.
-3. **Configuration Management UI:**
-    * Integrate configuration into the UI to allow for dynamic configuration.
+* Simple and repeatable local environment setup
+* Simple and repeatable cloud environment setup
+* Increased application flexibility
+* Ability to right-size features for different organizations
 
-### Success Metrics:
+## Professional Development Support (v0.10.0)
 
-* Increased completion of onboarding tasks before the new employees’ start dates
-* Increased user satisfaction with the onboarding process
-* Increased application flexibility
+1. **Role Library & Assignment**
+   - [ ] Add the ability to create and maintain job roles
+     - [ ] Create a versioning mechanism for roles in order to provide "moment in time" information
+   - [ ] Add the ability to assign and track roles over time
+2. **Generative AI Integration**
+   - [ ] Develop GenAI integration module
+   - [ ] Construct prompts and workflows that analyze notes, feedback, job descriptions, and skills data to provide summarized and actionable growth and performance insights
+   - **Construct prompts and workflows to provide personalized suggestions for mentors**
+     - [ ] Recommend development goals based on mentee information
+     - [ ] Suggest relevant learning resources or training opportunities
+     - [ ] Generate actionable development suggestions for increasing desired capabilities
+     - [ ] Incorporate generated suggestions into the check-in planning process
+3. **Career Timeline**
+   - **Create a timeline component to show important events in an employee's journey, including:**
+     - [ ] Role changes
+     - [ ] Title changes
+     - [ ] Joining/leaving a team
+     - [ ] Getting awarded a certification
+     - [ ] Joining/leaving a guild or community
+     - [ ] Completing a training event (stretch goal)
 
-## Professional Development Support (0.10.0)
+### Goals (v0.10.0)
 
-1. **Job Library & Assignment:**
-    * Build a comprehensive job library within the platform.
-    * Enable defining and assigning specific job roles.
-2. **Generative AI Integration:**
-    * Develop Google Gemini integration module.
-    * Construct prompts that analyze notes, feedback, job descriptions, and skills
-      data.
-    * Construct prompts to provide personalized suggestions for mentors:
-        * Recommend development goals based on mentee information.
-        * Suggest relevant learning resources or training opportunities.
-        * Generate actionable development suggestions for increasing desired capabilities.
-    * Incorporation of generated suggestions into the check-in planning process.
+* Higher engagement with the Check-Ins planning workflows
+* Improved employee development and career planning outcomes
+* Provide a view of an employee's career and development journey
 
-### Success Metrics:
+## Some day...
 
-* Higher engagement with the Check-Ins workflows
-* Enhanced employee development and career planning outcomes
+1. **Revive Onboarding Application:**
+   * Reintroduce and refresh the onboarding application