Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci Bring back Hyde Aug 10, 2018
.github Adding GitHub templates Feb 17, 2017
_accessibility-inclusivity Change link from DSS -> Home Affairs Aug 23, 2018
_assets Improve example and add images Feb 23, 2018
_content-structure Fix license typo Aug 31, 2018
_formatting Italics and dates link fixes Jun 5, 2017
_includes Fix PMC footer link Aug 16, 2018
_layouts Design Guide references: change them to Design System Aug 17, 2018
_numbers-measurements Add abbreviation of thousands Oct 31, 2017
_pages Remove redundant link Aug 24, 2018
_plugins Change from jekyll-lunr-js-search gem to a modified local version Mar 2, 2017
_punctuation-grammar fix typo on this page Jun 14, 2018
_search-engines Remove typo Feb 23, 2018
_terms-phrases Design Guide references: change them to Design System Aug 17, 2018
_types-of-content Design Guide references: change them to Design System Aug 17, 2018
_writing-style Improve guidance on tables Jan 11, 2018
images/uikit/icons Serve uikit images locally Dec 18, 2017
.editorconfig Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
.gitignore Removes npm-debug.log, and amends gitignore accordingly. Mar 6, 2017
.gitmodules Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
.ruby-version Update RVM config with new ruby Aug 10, 2018
CHANGELOG.md Update changelog Aug 17, 2018
Gemfile Upgrade Ruby and Jekyll to latest Aug 9, 2018
Gemfile.lock Upgrade Ruby and Jekyll to latest Aug 9, 2018
LICENSE.md Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
README.md Update README to add tests repo Aug 8, 2018
_config.yml Clean up the _config.yml Aug 10, 2018
android-chrome-192x192.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
android-chrome-512x512.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
apple-touch-icon.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
browserconfig.xml Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
favicon-16x16.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
favicon-32x32.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
favicon.ico Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
index.md Update home page and changelog Feb 23, 2018
manifest-production.yml testing move to circle with dynamic test- branches Dec 11, 2017
manifest-staging.yml added new circleci 2 and test- branches Dec 11, 2017
manifest-testing.yml added new circleci 2 and test- branches Dec 11, 2017
manifest.json Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
manifest.yml Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
mstile-150x150.png Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017
nginx.conf Add nginx.conf file Sep 18, 2017
robots-production.txt added robots.txt Nov 17, 2017
robots.txt added robots.txt Nov 17, 2017
safari-pinned-tab.svg Adding all the things! (Initial commit porting the dto-design-guide t… Feb 7, 2017

README.md

Content Guide

This guide is designed to help people working in the Australian Government create simpler, clearer and faster information.

Live site: https://guides.service.gov.au/content-guide/

Staging site: https://content-guide.apps.y.cld.gov.au/

Test sites: https://content-guide-[test-branchname].apps.y.cld.gov.au/

Visual tests: https://github.com/govau/backstop-content-guide-tests


Table of contents

  1. Feedback
  2. Contributing
  3. Developer information
  4. Copyright and license

Feedback

You can leave feedback to the guide in numerous ways:

  1. via the email feedback buttons and links in the guide (Please join our Content Design in Government Google Group to give feedback)
  2. via GitHub issues.

Contributing

ToDo: add useful information here :)

Markdown

To mark-up your content, write in Markdown. We use the 'kramdown' (default) markdown parser, which provides a couple of extra features. For a reference on what's possible see the kramdown quick reference.

Developer information

This guide is built with Jekyll.

Setup

You would only need to do the following if you are a developer. If you are a content editor you can access and editing content for the guide directly via GitHub. However, it can be nice having the guide locally to work and preview --- feel free to ask a developer if you would like to set up a local instance of the guide.

Requirements

  • Ruby
  • Jekyll

We also pull in the 1.x version of the UI-Kit as a submodule.

We will likely change this, and instead package up everything needed to produce a new guide scaffold as a Ruby gem for Jekyll to consume.

Setup locally

git clone git@github.com:govau/content-guide.git 
cd content-guide
git submodule init
git submodule update
gem install bundler
bundle install

Launch locally

bundle exec jekyll serve

If you get gem errors, try

rbenv rehash

If you still have troubles ask for help! (:

Broken link testing

Internal links are tested as part of the CI build pipeline in bin/citest.sh, however to keep test results reproducible external links are skipped.

You should periodically manually test external links with:

bin/checkexternal.sh

Copyright and license

Copyright Digital Transformation Agency. Licensed under the Creative Commons Attribution 4.0 International Public License. See LICENSE file for more details.

About the DTA

The Content Guide is maintained and funded by the Digital Transformation Agency.