bcgov / common-service-showcase

Website for user documentation and marketing of the common services built by the Common Service Showcase Team

Common-Service-Showcase

Website for user documentation and marketing of the common services built by the Common Service Showcase Team.

GitHub Pages

We are using GitHub Pages with gh-pages branch publishing source. We have set gh-pages as the default branch and we require that all changes are done via Pull Requests. However, in order to review/preview the changes, one must run the site locally.

Content

The site is built with Jekyll, so start by reviewing their documentation. Jekyll in turn uses Markdown, Liquid, HTML & CSS to generate the static site.

Collections

The site uses multiple pages, some of which are built from collections. See the collections key in the config.yaml

/collections is the directory that collections go in.

/collections/_services is the most likely spot to need to add new collections. Markdown files added here with the correct Front Matter will dynamically create the new pages, their navigation items, and add to lists on multiple pages.

Publishing

GitHub Pages understands Jekyll and will build and deploy sites automatically, do not check in the _site directory.

1. Fork the Common Service Showcase repository
2. Checkout gh-pages branch
3. Create branch from gh-pages
4. Add new collections (services), or other content
5. Build with Jekyll
6. Review your changes
7. Commit and push your changes to your fork.
8. Make a Pull Request in Common Service Showcase repository.
9. Ask for a review and approval of changes.

Build with Jekyll

1. Install a full Ruby development environment.

   Windows: visit https://rubyinstaller.org/downloads/ and download latest version WITH Devkit option. Install the installer (when prompted, just tap enter to use defaults - may happen twice).

   MacOS: use chruby and ruby-install to install the latest version (MacOS comes with an outdated version). It can be installed via Homebrew.

   For up-to-date instructions on installing Ruby, please see Jekyll's installation page.

2. Install Jekyll and Bundler. Open a console window with directory at root of this repo and run:

   gem install jekyll bundler

3. Install bundler gems:

   bundle install

   If using MacOS, run the following before bundle install:

   bundle config build.nokogiri --use-system-libraries

4. Build and serve site (locally):

   bundle exec jekyll build
   bundle exec jekyll serve

5. Go to site: http://localhost:4000/common-service-showcase/

common-service-showcase's Issues

Carbone Render - NPM Package

Published here: https://www.npmjs.com/package/@bcgov/carbone-render
Source Code here: https://github.com/bcgov/common-services-team-library/tree/master/npm

DGRSC - Document Generation Showcase

An application to showcase the capabilities of CDOGS (Common Document Generation Service) API.
Also to host a performance dashboard for the CDOGS: https://dgrsc.pathfinder.gov.bc.ca/dgrsc/#/performance

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

COMFORT - Common Forms Toolkit

An application stack that can host multi-tenant custom built forms with Role Based Access Controls, Public form submission, Secure Admin view of Submission Data, Status tracking, and dashboard analytics (Metabase)

Common Service Catalogue

The github pages website that lists the available common services.
https://bcgov.github.io/common-service-showcase/

File Cache - NPM Package

Published here: https://www.npmjs.com/package/@bcgov/file-cache
Source Code here: https://github.com/bcgov/common-services-team-library/tree/master/npm

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

• If this product is being actively maintained, please close this issue.
• If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

GETOK - Automated Access to Common Service APIs

https://getok.pathfinder.gov.bc.ca/getok/about

Carbone Copy API - NPM Package

Published here: https://www.npmjs.com/package/@bcgov/carbone-copy-api
Src Code here: https://github.com/bcgov/common-services-team-library/tree/master/npm

CHES - Common Hosted Email Service

The showcase applications and metrics for CHES are shown here: https://mssc.pathfinder.gov.bc.ca/mssc/app/performance

Pdf Generation with Libre Office - Docker Hub Image

Published here: https://hub.docker.com/r/bcgovimages/alpine-node-libreoffice
Source code here: https://github.com/bcgov/common-services-team-library/tree/master/images

CDOGS - Common Document Generation Service

The showcase application is accessible here: https://dgrsc.pathfinder.gov.bc.ca/dgrsc/#/performance

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means its critical that we work to make our content as discoverable as possible; Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

That's in, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

• If your org is not in the list below, or the table contains errors, please create an issue here.

• While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

• Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

• If your application is live, add the production URL.

Ministry Short Codes

Short Code	Organization Name
AEST	Advanced Education, Skills & Training
AGRI	Agriculture
ALC	Agriculture Land Commission
AG	Attorney General
MCF	Children & Family Development
CITZ	Citizens' Services
DBC	Destination BC
EMBC	Emergency Management BC
EAO	Environmental Assessment Office
EDUC	Education
EMPR	Energy, Mines & Petroleum Resources
ENV	Environment & Climate Change Strategy
FIN	Finance
FLNR	Forests, Lands, Natural Resource Operations & Rural Development
HLTH	Health
FLNR	Indigenous Relations & Reconciliation
JEDC	Jobs, Economic Development & Competitiveness
LBR	Labour Policy & Legislation
LDB	BC Liquor Distribution Branch
MMHA	Mental Health & Addictions
MAH	Municipal Affairs & Housing
BCPC	Pension Corporation
PSA	Public Safety & Solicitor General & Emergency B.C.
SDPR	Social Development & Poverty Reduction
TCA	Tourism, Arts & Culture
TRAN	Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

MSSC - Messaging Service Showcase

The Showcase application used to demonstrate the capabilities of the CHES (Common Hosted Email Service) API.
Also to host the performance dashboard for CHES: https://mssc.pathfinder.gov.bc.ca/mssc/app/performance

Document Generation API - DockerHub Image

Published here: https://hub.docker.com/r/bcgovimages/doc-gen-api
Source code here: https://github.com/bcgov/common-services-team-library/tree/master/images

Common Hosted Forms Service

A hosted service that allow users to build forms and publish a form that can then be used to collect and review data submissions