Skip to content
This repository has been archived by the owner on Aug 15, 2020. It is now read-only.

Latest commit

 

History

History
147 lines (106 loc) · 7.03 KB

README.md

File metadata and controls

147 lines (106 loc) · 7.03 KB
Raw

Toolkit

CircleCI Maintainability Project Board Percy

Installation

Run each of the following steps to get the site up and running.

  1. git clone https://github.com/ServiceInnovationLab/serviceinnovationlab.github.io.git
  2. cd serviceinnovationlab.github.io
  3. bundle install
  4. bundle exec jekyll serve --watch

You should be able to see the site at: http://127.0.0.1:4000/

Instructions for Adding Content

NOTE: These steps only apply to people involved with the Lab

Setting up a file for changes

  • Log in to GitHub.
  • Navigate to the Toolkit's repo.

Adding content

  1. To Add Media: Ensure that you are on the dev branch, then navigate to assets/media (OR if its a Blog post, navigate to assets/media/img/report-images ).

  • Click on the Upload files button & choose your preferred method (eg. Dragging the file OR clicking on the choose your files link). Note: Your image should be saved & named (in lowercase & use a hyphen instead of spaces) in an easily identifiable way.

    OR

  1. To Add content: Ensure that you are on the dev branch, then navigate to the appropriate part of the site that you want to add your content to. (ie. _products_projects for Reusable Components; _services_projects for Stuff that we've done; pages for New pages; & _posts for Blog posts)
  • Click on the Create new file button. In the textfield which appears, type in the name of your file in this format (in lower case) (eg. lower-case.md) EXCEPT for Blog posts where the format should be (eg. YYYY-MM-DD-this-is-a-blog-post.md). Then proceed to add your content. Note: Refer to an existing file to see the how the format should be.

Markdown Cheat Sheet

  • Scroll to the bottom of the page.
  • Enter a Commit message (compulsory) saying what you did (eg. Added some new content).Commit message
  • Enter a further extended Description (optional) for your changes. Description message
  • Select the Radio Button corresponding to the text "Create a new branch for this commit and start a pull request.".
  • In this box, Branch name type in a meaningful name (eg. adding-some-content) for the branch which you are creating. Note: Your branch name should be in lowercase, use a hyphen instead of spaces, & start with content/ if you are adding some sort of content then click on the Propose file change button. Example of how it might look like: content/adding-some-content.
  • Click on Commit new file button
  • You should then be re-directed to another page entitled Open a pull request.

See Creating a Pull Request

Approving Content

  • Click on the Pull requests tab (located near to the top of the page).
  • Click on the PR that you have been selected to review.
  • To review the changes, click on the Files changed tab (located under the title of the PR).
  • Once done, click on the Conversations tab, then click on the green Add your review button (within the yellow banner at the top of the page). You should then be re-directed to a page & a "pop-up" box will appear.
  • Fill in your comments for the PR & select the appropriate Radio button (ie. Comment; Approve; or Request Changes) depending on what actions you see fit. See: Dev Peer Review Workflow PR Feedback/Reviews & Commit Messages sections for help.
  • Once done, click on the green Submit review button. And that's it, you have made your review!

Skeleton templates for pages

Note: These are just an example. Please refer to the ones already created if unsure.

Team page

---
name: jacob-ong
first_name: Jacob
last_name: Ong
full_name: Jacob Ong
role: Developer
image:
active: true
# published: false (Delete the # if the team member becomes a publisher)
---

Pages

---
title: New Page
permalink: /newPage/ # In camelCase
layout: primary
lead: This is a new page.
---

Projects/tools

(Feel free to delete the ones you do not use)

---
agency: SIL
title: New Project
subtitle: Creating a new project.
permalink: /projects/new-project/
excerpt: Information for creating a new project.
image: /assets/img/projects/new-project.png
image_accessibility: New project.
project_url: "[New Project](https://www.serviceinnovationlab.github.io/projects/new-project/)"
github_repo: "[New Project](https://github.com/ServiceInnovationLab/New-Project)"
report: "[Project's Report](/YYYY/MM/DD/New-Project/)"
media: "[Project's Media/Link](https://www.serviceinnovationlab.github.io/)"
resources: "[Project's Resources/Templates](/templates/new-project)"
---

Blog posts

---
title: Blog Post
date: YYYY-MM-DD
authors:
  - jacob-ong
tags:
  - blog post
  - open source
excerpt: ""
---

Accessibility Tests

We must meet the New Zealand Government - Web Accessibility Standard 1.1 on this toolkit.

We used automated testing to detect some inaccessible content. These tests are gatekeepers. When the content added doesn't comply, the PR will have a failed test. Receiving automated messages that your work didn't pass can be frustrating at first, but compliance is necessary and becomes easier with practice.

The tests will not catch every accessibility problem. We still should spend time checking the toolkit, and generally keeping proficient accessibility standards.

Git Branches

Jekyll config (including markdown, and layout html) are in the dev branch, which is also the default branch on github.

The resulting static site is built by circle-ci. The deploy task runs on any change to the dev branch. (see .circleci/config.yml).

The static site content (html, css, js, images) is then committed to the master branch. Github Pages is configured for this repo to serve from the master branch.

Note: Github Pages for organisations must be served from the master branch. At this time the branch name is not configurable.