Giter VIP home page Giter VIP logo

bcgov / digital-toolkit Goto Github PK

View Code? Open in Web Editor NEW
8.0 7.0 4.0 7.28 MB

The BCGov Digital Toolkit is the reference repository for digital best practices across our teams

Home Page: https://digital-toolkit.pathfinder.gov.bc.ca/

License: Apache License 2.0

HTML 24.89% CSS 45.35% JavaScript 26.75% Ruby 1.57% Shell 0.96% Dockerfile 0.48%
british-columbia digital toolkit jekyll guidelines government policy

digital-toolkit's Introduction

BCGov Digital Toolkit

The BCGov Digital Toolkit is the reference repository for digital best practices across our teams. Most of our guides are open source, and you are free to use them as you wish.

Our hope is that other digital service teams, both inside and outside of the BC government, will adopt or modify the practices outlined here.

By developing this material in the open, we hope to encourage expert review and contributions from members of the tech community, furthering our goal of improving how government works through increased civic engagement with tech specialists.

This site was developed using approved BC Government standards in respect to branding, functionality, and information architecture.

Contribute to this Project

See the wiki for a full set of instructions on how to contribute to the guides hosted here.

Developer Installation

In order to install this website and the collection of digital guides onto your local computer, follow the instructions below. Please note that while contributions to the guides and front-end code of the website are welcome, the Government of British Columbia does not authorize the public publication of this website on any top level domains external to gov.bc.ca or internal domains other than .bcgov

You may install and run this website locally and you may use its source code as the foundation for a project of your own. However, copying and redistributing the source code without modifications is prohibited.

  1. Ensure you have Ruby, Bundler and Jekyll installed.
  2. Clone this repository: git clone https://github.com/bcgov/digital-toolkit.git
  3. Change directory into the project root: cd digital-toolkit
  4. Serve the site locally: bundle exec jekyll serve --watch

Watching files for changes

Run bundle exec jekyll serve --watch in order to serve the site locally and to watch the source files for changes. Re-saving a file will cause the site to be re-generated when using the --watch option.

Pull requests for website changes

Pull requests to the source code of the website are welcomed and appriciated. In order to contribute to the content of the site see the wiki.

Static assets and binary files

Static images and CSS, JS, etc. are served from the /static folder off of the root of the project. Move any static files to this directory and when Jekyll builds the site, the files will end up at: <example-site.com>/static/<file-name.file> For example, if you place foo.jpg inside /static/img, the file will be served from example-site.com/static/img/foo.jpg

Modifications made to the default BC Gov theme

Some changes made to the BC Gov Skeleton (of which this site is based off) are:

  1. Line 302 of src/js/bc-gov/misc.js is commented out - This line intentionally offset the scroll position when scrolling to an anchor on the page. This was done because the default theme has a "sticky" header/navigation while this site does not.

When you are ready to publish the site

Important! Set the JEKYLL_ENV variable to production via the command line by adding it to your build command, like this: JEKYLL_ENV=production bundle exec jekyll serve or JEKYLL_ENV=production jekyll build

Setting the JEKYLL_ENV to production will compile the site with certain features enabled, such as analytics.

For a full list of dependancies, or to use with Docker, see the Dockerfile

Approving changes made on GitHub

We pull the publishing source code from the os-pages branch. (Do not delete this branch, the build will break).

The public and employees of the BCPS will make changes to the master branch. When these changes have been reviewed and approved, simply merge them to the os-pages branch with git or GitHub (instructions for GitHub follow). This will trigger a webhook that will publish the changes live to https://digital-toolkit.pathfinder.gov.bc.ca/.

In order to merge changes directly on GitHub:

  1. Visit: https://github.com/bcgov/digital-toolkit/tree/os-pages
  2. Click "Pull Request" or visit: https://github.com/bcgov/digital-toolkit/compare/os-pages...master
  3. Create a pull request, giving details outlining the changes. Here is a great place to disscuss changes with other members of the team. You should see "Able to merge. These branches can be automatically merged." at the top of the page. If not, review the changes well. A conflicting change generally means a big change.
  4. Optionally, assign reviewers and assignees, and lables.
  5. Click "Create pull request"
  6. You now have your pull request! You may disscuss it furthur with your team via the comments box, or, you can click the shiny "Merge pull request" button in order to make your changes live on the os-pages branch (aka https://digital-toolkit.pathfinder.gov.bc.ca/)

digital-toolkit's People

Contributors

agehlers avatar jeetz2 avatar jeznorth avatar jonathanbell avatar robertgoesbyjim avatar sheaphillips avatar shellyxuehan avatar waffle-iron avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

digital-toolkit's Issues

Apply CSS to Guides

Guide of Guides is the only one with the BCGov CSS applied. Need to do all guides and template.

Grammer

Section 2: Resources:
I want to good content for the Web

Create demo slide deck

The innovation toolkit proof of concept needs to be showed around gov to help raise awareness of the team and technology learnings

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.

add 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.

Update Step descriptions

  1. Address legislation, privacy and security by design
  2. Leverage flexible deployment
  3. Achieve continuous improvement

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

This issue is a kind reminder that your repository has been inactive for 611 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!

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

This issue is a kind reminder that your repository has been inactive for 610 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!

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

This issue is a kind reminder that your repository has been inactive for 608.07 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 608.07 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.

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

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

This issue is a kind reminder that your repository has been inactive for 609 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!

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 :)

Innovator's Toolkit R1

Value: $9,000.00Closes: Thursday, February 8, 2018Location: Victoria Some in-person work required

Opportunity Description

As the Government of British Columbia increases delivery of digital services, there is a need to help all stakeholders understand what “digital” means.   At the same time, there is a subset of stakeholders that will need to know what tools, techniques, and methodologies are recommended for their use to design and build digital services.  The website described by the GitHub repositories in the next paragraph is a first iteration, a prototype, of a “Digital Guide” for the Government of British Columbia.

Beginning a journey towards a “BC Digital Guide,” this site is the first step.  Modelled after 18F in the U.S. and UK Government Digital Service, the government reference in this repository, supported by the guides found through this repository  is organized like this (from the FAQ):  “You’ll find three layers to the toolkit: (i) a front page describing basic steps and principles, (ii), a set of high level guides that further define those steps and principles, and (iii) detailed guides providing a deeper level of information and instruction with those responsible for designing and delivering simple, streamlined, modern services.” 

This iteration intends to build out content, to fill in the blanks, as it were, to take the collection of guides to a first official release.  Most of this work is focused on updating the detailed guides, adding new guides, and providing links to other good related government references.

Phase 1

Propose a methodology or mechanism to facilitate contribution from anyone across government

Propose a method of measuring, collecting, and analysing visitor behaviour so that the content, navigation, and overall service can be improved.

Implement both of these methods.

Phase 2

Fix navigation so that it works as expected, forward and back.

Provide a Search function on the home page so that content on that page is easier to find.

Correct feedback and email links to proper endpoints (to be provided.)

Include new and updated content (to be provided.)

Include a section for “Corporate Enablers”, and a one-page description of what each is, and how to consume them (content to be provided).

Include an expanded collection of links for DataBC (links to be provided).

Acceptance Criteria

  • Work with our Agile/Scrum team (4000 Seymour Place in Victoria, BC):
    • The DigitalToolkit team works in 1-week sprints. You will attend in-person planning (2 hours) and review (3 hours) meetings for each sprint.
    • You will track your work with the team on our DigitalToolkit Trello board
  • Completion of Phase 1  $4,000
  • Completion of Phase 2  $5,000

How to Apply

Go to the Opportunity Page, click the Apply button above and submit your proposal by 16:00 PST on Thursday, February 8, 2018.

We plan to assign this opportunity by Saturday, February 10, 2018 with work to start on Wednesday, February 14, 2018.

Proposal Evaluation Criteria

  1. Your confirmation of being able to commit the time to meet all of the Acceptance Criteria by Wednesday, February 7, 2018.
  2. A short (200 words or less) summary of your experience working with agile projects (40 points).
  3. References to your relevant experience and demonstrated ability to do the work (60 points). For example, a link to your GitHub projects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.