docs: readme

README.md

@@ -1,253 +1,23 @@
-<!-- PROJECT SHIELDS -->
+[![Merge](https://github.com/bcgov/onroutebc/actions/workflows/merge-main.yml/badge.svg)](https://github.com/bcgov/onroutebc/actions/workflows/merge.yml)
+[![Analysis](https://github.com/bcgov/onroutebc/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/bcgov/onroutebc/actions/workflows/analysis.yml)
 
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bcgov_onroutebc&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=bcgov_onroutebc)
-[![Merge to Main](https://github.com/bcgov/onroutebc/actions/workflows/merge-main.yml/badge.svg)](https://github.com/bcgov/onroutebc/actions/workflows/merge-main.yml)
-[![Unit Tests and Analysis](https://github.com/bcgov/onroutebc/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/bcgov/onroutebc/actions/workflows/unit-tests.yml)
-
-[![Issues](https://img.shields.io/github/issues/bcgov/onroutebc)](/../../issues)
-[![Pull Requests](https://img.shields.io/github/issues-pr/bcgov/onroutebc)](/../../pulls)
-[![MIT License](https://img.shields.io/github/license/bcgov/onroutebc.svg)](/LICENSE.md)
+[![License](https://img.shields.io/github/license/bcgov/onroutebc.svg)](/LICENSE)
 [![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
 
-# QuickStart: OpenShift, TypeScript and Postgres/PostGIS
-
-The DevOps Quickstart is a fully functional set of pipeline workflows and a starter application stack intended to help Agile DevOps teams hit the ground running.  Currently OpenShift is supported with plans for AWS (Amazon Web Services).  Pipelines are run using [GitHub Actions](https://github.com/bcgov/onroutebc/actions).
-
-Features:
-* Pull Request-based pipeline
-* Sandboxed development deployments
-* Gated production deployments
-* Container publishing (ghcr.io) and importing (OpenShift)
-* Security, vulnerability, infrastructure and container scan tools
-* Automatic Dependabot dependency patching with Pull Requests
-* Enforced code reviews and pipeline checks
-* Templates and setup documentation
-* Starter TypeScript application stack
-
-# Workflows
-
-## Pull Request Opened
-
-Runs on pull request submission.
-
-- Provides safe, sandboxed deployment environments
-- Build action pushes to GitHub Container Registry (ghcr.io)
-- Build triggers select new builds vs reusing builds
-- Deployment includes curl checks and optional penetration tests
-- Other checks and updates as required
-
-![](common/graphics/pr-open.png)
-
-## Pull Request Closed
-
-Runs on pull request close or merge.
-
-- Cleans up OpenShift objects/artifacts
-- Merge promotes successful build images to TEST
-
-![](common/graphics/pr-close.png)
-
-## Merge to Main
-
-Runs on merge to main branch.
-
-- Code scanning and reporting to GitHub Security overview
-- Zero-downtime* TEST deployment
-- Penetration tests on TEST deployment
-- Zero-downtime* PROD deployment
-- Labels successful deployment images as PROD
-
-\* excludes database changes
-
-![](common/graphics/merge-main.png)
-
-## Unit Tests
-
-Runs on pull request submission or merge to main.
-
-- Unit tests (should include coverage)
-- Optionally, report results to Sonarcloud
-
-![](common/graphics/unit-tests.png)
-
-# Starter Application
-
-The starter stack includes a frontend, backend and postgres database.  The frontend and backend are buld with [NestJS](https://docs.nestjs.com).  They currently do very little, but provide placeholders for more functional products.  See subfolder for source, including Dockerfiles and OpenShift templates.
-
-Features:
-* [TypeScript](https://www.typescriptlang.org/) strong-typing for JavaScript
-* [NestJS](https://docs.nestjs.com) frontend and backend
-* [Postgres](https://www.postgresql.org/) or [PostGIS](https://postgis.net/) database
-* [backup-container](https://github.com/BCDevOps/backup-container) provided by BCDevOps
-
-Postgres is default.  Switch to PostGIS by copying the appropriate Dockerfile to `./database`:
-
-> cp ./database/postgis/Dockerfile ./database
-
-Test and develop locally with Docker Compose:
-
-> docker-compose up -d
-
-**Example APIs, UIs and Metabase/Oracle Templates**
-
-Templates for APIs, UIs and Metabase/Oracle can be used to kickstart or extend projects.  Please visit our collaborators' [NR Architecture Templates](https://github.com/bcgov/nr-arch-templates) repository for more information.
-
-# Getting Started
-
-Initial setup is intended to take four hours or less.  This depends greatly on intended complexity, features selected/excluded and outside cooperation.
-
-## Prerequisites
-
-The following are required:
-
-* BC Government IDIR accounts for anyone submitting requests
-* GitHub accounts for all participating team members
-    * [Sign Up is free](https://github.com/signup)
-* Membership in the BCGov GitHub organization
-    * Provide GitHub IDs to [BCGov's Just Ask](https://just-ask.developer.gov.bc.ca/)
-* Project namespaces:
-    * OpenShift - [Register a New Project](https://registry.developer.gov.bc.ca/public-landing)
-
-
-
-## GitHub Repository from Template
-
-Create a new repository using this repository as a template.
-
-* Select bcgov/onroutebc under Repository template
-* Check Codecov | Code Coverage to grant access
-* Jira cannot be unchecked (I try every time!)
-
-![](./common/graphics/template.png)
-
-
-## GitHub Secrets
-
-Secrets are consumed by workflows.  There are multiple kinds.  Please expect to secrets to change across Environments, like PR/DEV, TEST and PROD.  Even Dependabot has its own set.
-
-### Repository
-
-Repository secrets are available to all workflows, except pull requests triggered by Dependabot.
-
-> Click Settings > Secrets > Actions > New repository secret
-
-### Environment
-
-Environments are groups of secrets that can be gatekept.  This includes limting access to certain users or requiring manual approval before a requesting workflow can run.
-
-> Click Settings > Environments > Environment Name / New environment > Add secret
-
-Environements provide a [number of features](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment), including:
-
-* Required reviewers
-* Wait timer
-* Deployment branches
-
-### Dependabot
-
-Dependabot secrets are used by Dependabot's pull requests.  See [.github/dependabot.yml](./.github/dependabot.yml) for an example.
-
-> Click Settings > Secrets > Dependabot > New repository secret
-
-## Secret Values
-
-**GITHUB_TOKEN**
-
-Default token.  Replaced every workflow run, available to all workflows.
-* Variable: `{{ secrets.GITHUB_TOKEN }}`
-
-**OC_SERVER**
-
-OpenShift server address.
-* Variable: `{{ secrets.OC_SERVER }}`
-* Value: `https://api.gold.devops.gov.bc.ca:6443` or `https://api.silver.devops.gov.bc.ca:6443`
-
-**OC_NAMESPACE**
-
-OpenShift project/namespace.  Provided by your OpenShift platform team.
-
-* Variable: `{{ secrets.OC_NAMESPACE }}`
-* Value: format `abc123-dev | test | prod`
-
-**OC_TOKEN**
-
-OpenShift token, different for every project/namespace.  This guide assumes your OpenShift platform team has provisioned a pipeline account.
-
-* Variable: `{{ secrets.OC_TOKEN }}`
-
-Locate an OpenShift pipeline token:
-
-1. Login to your OpenShift cluster, e.g.: [Gold](https://console.apps.silver.devops.gov.bc.ca/) or [Silver](https://console.apps.silver.devops.gov.bc.ca/)
-2. Select your DEV namespace
-3. Click Workloads > Secrets (under Workloads for Administrator view)
-4. Select `pipeline-token-...` or a similarly privileged token
-5. Under Data, copy `token`
-6. Paste into the GitHub Environment Secret `OC_TOKEN` (see above)
-
-**Sonar Tokens**
-
-If SonarCloud is being used each application will have its own token.  Single-application repositories typically use `${{ secrets.SONAR_TOKEN }}`, but monoreposities will have multiple, like `${{ secrets.SONAR_TOKEN_BACKEND }}` and `${{ secrets.SONAR_TOKEN_FRONTEND }}`.
-
-BC Government employees can request SonarCloud projects from [bcdevops/devops-requests](https://github.com/BCDevOps/devops-requests) by creating a SonarCloud request/[issue](https://github.com/BCDevOps/devops-requests/issues/new/choose).  This template expects a monorepo, so please ask for that and provide component names (e.g. backend, frontend).
-
-
-## Repository Configuration
-
-### Pull Request Handling
-
-Squash merging is recommended for simplified history and ease of rollback.  Cleaning up merged branches is recommended for your DevOps Specialist's fragile sanity.
-
-> Click Settings > General (selected automatically)
-
-Pull Requests:
-
-- `[uncheck] Allow merge commits`
-- `[check] Allow squash merging`
-  - `Default to pull request title`
-- `[uncheck] Allow rebase merging`
-- `[check] Always suggest updating pull request branches`
-- `[uncheck] Allow auto-merge`
-- `[check] Automatically delete head branches`
-
-### Packages
-
-Packages are available from your repository (link on right).  All should have visibility set to public for the workflows to run successfully.
-
-E.g. https://github.com/bcgov/onroutebc/packages
-
-### Branch Protection
-
-This is required to prevent direct pushes and merges to the default branch.  These steps must be run after one full pull request pipeline has been run.
-
-1. Select Settings (gear, top right) -> Branches (under Code and Automation)
-2. Click `Add Rule` or edit an existing rule
-3. Under `Protect matching branches` specify the following:
-    * Branch name pattern: `main`
-    * `[check] Require a pull request before merging`
-        * `[check] Require approvals` (default = 1)
-        * `[check] Dismiss stale pull request approvals when new commits are pushed`
-        * `[check] Require review from Code Owners`
-    * `[check] Require status checks to pass before merging`
-        * `[check] Require branches to be up to date before merging`
-        * `Status checks that are required`:
-            * Select checks as appropriate, e.g. Build x, Deploy y
-    * `[check] Require conversation resolution before merging`
-    * `[check] Include administrators` (optional)
-
-### Adding Team Members
+# OnRouteBC - Provincial Commercial Vehicle Permitting Solution
 
-Don't forget to add your team members!  
+## Summary
 
-1. Select Settings (gear, top right) -> Collaborators and teams (under Access)
-2. Click `Add people` or `Add teams`
-3. Use the search box to find people or teams
-4. Choose a role (read, triage, write, maintain, admin)
-5. Click Add
+The solution will have all commercial vehicle permit types available for application online and automate the approval and routing process for most permit applications. In addition onRouteBC will provide workflow tools to accommodate more complex functions such as Extraordinary Load (EL) approvals and bridge analysis. The project will include data migration from the legacy system and will leverage external systems to deliver some of the functionality required.
 
-# Feedback
+## Third-Party Products/Libraries used and the licenses they are covered by
 
-Please contribute your ideas!  [Issues] and [pull requests] are appreciated.
+## Project Status
+- [x] Development
+- [ ] Production/Maintenance
 
-# Acknowledgements
+## Documentation
+<!--- Point to another readme or create a GitHub Pages (https://guides.github.com/features/pages/) --->
 
-This Action is provided courtesty of the Forestry Suite of Applications, part of the Government of British Columbia.
+Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). 
+By participating in this project you agree to abide by its terms.