Skip to content

Commit

Permalink
docs(overview): Add docs for TDS overview and releases
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanoglesby08 committed Jul 24, 2017
1 parent 3305f6e commit 074f880
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 0 deletions.
9 changes: 9 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Upgrading Guide

### DEPRECATION NOTICE (24 July 2017)

This document will no longer be maintained and may be removed in the future. We have moved to using [Github Release Notes](https://github.com/telusdigital/tds/releases)
to communicate changes in releases, including deprecated features and breaking changes.

* For a summary of important changes in a release, including any upgrade instructions, read the [Release Notes](https://github.com/telusdigital/tds/releases).
* For a comprehensive list of the important changes in a release, read the [Changelog](https://github.com/telusdigital/tds/blob/master/CHANGELOG.md).


## Upgrading to v0.16.x

### NEW CDN files
Expand Down
10 changes: 10 additions & 0 deletions config/styleguide.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ module.exports = {
showCode: true,

sections: [
{
name: 'TELUS Design System',
content: '../docs-new/intro/overview.md',
sections: [
{
name: 'Releases',
content: '../docs-new/intro/releases.md'
}
]
},
{
name: 'Foundational Elements',
sections: [
Expand Down
1 change: 1 addition & 0 deletions docs-new/intro/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Welcome to the TELUS Design System (TDS).
7 changes: 7 additions & 0 deletions docs-new/intro/releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
TDS releases often, and we put every effort into making the upgrade process as smooth as possible. Refer the the following
links for information about any TDS release.

* [Github Releases](https://github.com/telusdigital/tds/releases): A summary of the important changes for all releases,
including deprecated features, breaking changes, and any upgrade instructions.
* [Github Latest Release](https://github.com/telusdigital/tds/releases/latest): A summary of the latest release.
* [Full Changelog](https://github.com/telusdigital/tds/blob/master/CHANGELOG.md). A comprehensive list of all changes by release.

0 comments on commit 074f880

Please sign in to comment.