Skip to content
Permalink
Browse files

Update Colophon schema version and example file (#231)

  • Loading branch information...
kspaans authored and ruxandrafed committed Apr 16, 2019
1 parent 8f23115 commit c4b8f1edc376aabc5af305f665b6e25c3b798450
Showing with 47 additions and 15 deletions.
  1. +47 −15 development/colophon.md
@@ -13,43 +13,75 @@ The `README` file is a typical place where this information can be found. This w

## What

Use a `colophon.yml` file in your repository that follows the [Colophon schema](https://github.com/project-colophon/schema).
Use a `.colophon.yml` file in your repository that follows the [Colophon schema](https://github.com/project-colophon/schema).

## How

A simple `colophon.yml` (or use JSON if you prefer) looks like the following:
A simple `.colophon.yml` (or use JSON if you prefer) looks like the following:

```yaml
version: 1.0.0
version: 2.0
id: telus-widgets
id: my-awesome-app
about:
title: TELUS Widgets
description: Best widget maker in Canada!
title: My Awesome App
description: app that makes everything awesome!
contacts:
humans: Widget Maker <widgets@telus.com>
- type: department
name: Awesome Department
email: awesome@telus.com
- type: developers
name: app development
email: app-dev@telus.com
- type: qa
name: app qa
email: app-qa@telus.com
- type: Lead Developer
name: Alex Smith
email: ahmad@telus.com
- type: Lead Designer
name: John Smith
email: alex@telus.com
schedule:
launch: 2018-05-24T03:35:40.968Z
sunset: 2020-01-31T03:35:40.968Z
environments:
- type: production
title: URL
uri: "https://www.telus.com/widgets"
description: Web Application URL
uri: https://www.telus.com
- type: test
title: URL
uri: "https://www.wctest.telus.com/widgets"
- type: git
title: Source Code
uri: https://github.com/telus/widgets
description: Web Application URL
uri: http://test.telus.com
- type: production
title: Database
description: Application Database
uri: mongodb://prod.db.telus.com:27017/acme
references:
- title: Documentation
uri: https://github.com/telus/widgets/wiki
- title: JIRA
description: application backlog & issues
uri: https://telusdigital.atlassian.net/projects/APP/issues/
- title: Wiki
description: application technical wiki
uri: https://github.com/telus/app/wiki
```

The `id` can be used to link this GitHub repo to the project via other mediums, such as by placing the `id` in an HTML `meta` tag, or the HTTP header response of an API.

See the [spec](https://github.com/project-colophon/schema/tree/master/schema/1.0) for other fields that may be appropriate for your project.
See the [spec](https://github.com/project-colophon/schema/tree/master/schema/2.0) for other fields that may be appropriate for your project.

## Who

0 comments on commit c4b8f1e

Please sign in to comment.
You can’t perform that action at this time.