Skip to content
This repository has been archived by the owner on Dec 6, 2022. It is now read-only.
Simon Hobbs edited this page Aug 6, 2019 · 60 revisions

GovCMS Developer Wiki

Introduction

Welcome to the GovCMS developer wiki. This is a community maintained wiki which is curated by the GovCMS team at the Department of Finance. This wiki is focussed on developers and site builders who are getting started with GovCMS. The goal is to use clear language, useful overviews, and supplement this with links to other resources.

Guide to maintaining this wiki

  • Avoid duplication, use links to existing material.
  • Avoid writing in the 1st person as it implies the GovCMS team is speaking.
  • Try to use existing top-level sections.
  • Imagine the reader has basic working knowledge of Docker, Lagoon, IRAP, and other acronyms.
  • Where practical, please use http://asciiflow.com to draw diagrams.
  • Feel free to use the Scratchpad for incoming material or questions.
  • During 2019, you can ping Si if there are serious issues with accuracy or structure.

Meta - migrating content from READMEs

It is currently hard to update READMEs in git repos due to governance. Additionally, docs are being duplicated via the use of scaffolds and such. The plan is to move how-to's out of READMEs and into this wiki, and make some other wikis redundant.

List of READMEs in scope:

Project Docs Plan
govCMS/govcms8_uikit_starter readme, no wiki No change
govCMS/govcms readme rationalise README, Wiki is this wiki
govCMS/govcms8 readme, wiki rationalise README, Wiki already merged
govCMS/govcms7-scaffold readme, no wiki rationalise README
govCMS/govcms7-scaffold-paas readme, no wiki rationalise README
govCMS/govcms8-scaffold readme, no wiki rationalise README
govCMS/govcms8-scaffold-paas readme, no wiki rationalise README
govCMS/govcmslagoon readme, no wiki No plan
govCMS/govcms8lagoon readma, no wiki No plan