chore(guide): clean up links to make them GitHub friendly

telus · Jan 18, 2018 · afbc684 · afbc684
1 parent 9eb7f35
commit afbc684
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 28 deletions.
diff --git a/guide/SUMMARY.md b/guide/SUMMARY.md
@@ -9,7 +9,7 @@
 * [Contributing](./contributing/contributing.md)
   * [Designer guide](./contributing/designer-guide.md)
   * [Developer guide](./contributing/developer-guide.md)
-  * [Codebase overview](codebase-overview.md)
+  * [Codebase overview](./contributing/codebase-overview.md)
 * [Roadmap](./roadmap.md)
 
 ## Design principles &amp; guidelines

diff --git a/guide/accessibility/accessibility.md b/guide/accessibility/accessibility.md
@@ -2,10 +2,10 @@
 
 The TDS documentation is a starting point for accessibility information. 
 
-  * [Colour and contrast](/accessibility/colour-contrast.md)
-  * [Keyboard navigation](/accessibility/keyboard-nav.md)
-  * [Screen readers](/accessibility/screen-readers.md)
-  * [Content](/accessibility/content.md)
+  * [Colour and contrast](./colour-contrast.md)
+  * [Keyboard navigation](./keyboard-nav.md)
+  * [Screen readers](./screen-readers.md)
+  * [Content](./content.md)
 
 You will find more detailed usage and implementation details at the following complementary sites.
 

diff --git a/guide/contact.md b/guide/contact.md
@@ -8,14 +8,14 @@ It is not intended for general public consumption.
 
 1. **GitHub**: Please discuss in [open issues](https://github.com/telusdigital/tds/issues) before 
   [creating a new one](https://github.com/telusdigital/tds/issues/new). See 
-  [Contributing guide](contributing/contributing.md#how-to) for more information.  
+  [Contributing guide](./contributing/contributing.md) for more information.  
   _Response time: within 3 business days<sup>1</sup>_
 2. **TELUS Digital Slack**: Channels exclusively available to TELUS digital employees, 
   contractors, and vendors.  
   _Response time: within 8 business hours<sup>1</sup>_
   - **#tds-guild** for general discussions, announcements, and design questions related to TDS
   - **#tds-tech-support** for fast support directly related to components or code within the TDS 
-  repository or served by the TDS npm package. If you do not require immediate support, it is preferred to [open a GitHub issue](./contributing/contributing.md#1-submit-issue)
+  repository or served by the TDS npm package. If you do not require immediate support, it is preferred to [open a GitHub issue](./contributing/contributing.md#1-submit-an-issue)
 3. **Anonymous form**: We would rather you use Github for logging all issues, however, you can [submit anonymous feedback](https://goo.gl/forms/8g8n7BMjvLJN7bDr1).
 4. **Email**: If all else fails then you can get intouch with the team [via e-mail](
 n6k7q6p0r9m4c1l4@telusdigital.slack.com)

diff --git a/guide/codebase-overview.md → guide/contributing/codebase-overview.md b/guide/codebase-overview.md → guide/contributing/codebase-overview.md
diff --git a/guide/contributing/contributing.md b/guide/contributing/contributing.md
@@ -8,22 +8,22 @@ other ways you can contribute, including submission of bug fixes, documentation
 
 That being said, we welcome contributions of _enhancements_ to the currently available components in accordance with 
 the component roadmaps. Check the [component documentation](ref://../components/index.html) to see what is on the roadmap 
-for each one. If you'd like to contribute to any of the available TDS components, [follow the steps below](#1-submit-issue).
+for each one. If you'd like to contribute to any of the available TDS components, [follow the steps below](#1-submit-an-issue).
 
 Expect architectural changes and governance processes to be established soon that will drive a more mature contribution 
 process. Thank you for your patience.  
 
-Learn more by reading the [TELUS Design Platform roadmap](/roadmap.md) or by [reaching out to us](/contact.md).
+Learn more by reading the [TELUS Design Platform roadmap](../roadmap.md) or by [reaching out to us](../contact.md).
 
 
-## How to contribute {#how-to}
+## How to contribute
 
-### 1. Submit an issue {#1-submit-issue}
+### 1. Submit an issue
 
 We use [Github Issues](https://github.com/telusdigital/tds/issues) to track all of our bugs and open discussions so that 
 they are visible to the community. 
 
-However, if you would like to make a small adjustment to documentation, you may jump straight to [opening a pull request](#3-pull-request). 
+However, if you would like to make a small adjustment to documentation, you may jump straight to [opening a pull request](#3-make-a-pull-request). 
 If you found a bug or would like to begin a conversation, follow these steps:
 
 * Ensure the issue was not already reported by searching the [issues](https://github.com/telusdigital/tds/issues)
@@ -43,11 +43,11 @@ There are different paths to developing a solution depending on your goal:
 to write code. You can follow this guide on [how to edit files within GitHub](https://help.github.com/articles/editing-files-in-your-repository/).
 When making commits, be sure to follow the [TELUS commit standards](https://github.com/telusdigital/reference-architecture/blob/master/process/contribution-model.md#commit-template).
 There is no need to create an issue first, you may edit documentation and create a pull request anytime.
-* **Designers producing assets or symbols**: follow the [designer guide](/contributing/designer-guide.md) to TODO FINISH THIS SENTENCE
-* **Developers making changes to components**: follow the [developer guide](/contributing/developer-guide.md) to set up your environment for TDS development and read the [codebase overview](/codebase-overview.md) to understand the structure of the codebase and 
+* **Designers producing assets or symbols**: follow the [designer guide](./designer-guide.md) to TODO FINISH THIS SENTENCE
+* **Developers making changes to components**: follow the [developer guide](./developer-guide.md) to set up your environment for TDS development and read the [codebase overview](./codebase-overview.md) to understand the structure of the codebase and 
 the conventions being followed
 
-### 3. Make a pull request {#3-pull-request}
+### 3. Make a pull request
 
 First, thanks for taking the time. :) 
 

diff --git a/guide/contributing/developer-guide.md b/guide/contributing/developer-guide.md
@@ -44,7 +44,7 @@ automatically refresh when there are changes to any of the source files.
 
 ## Write some code
 
-Read the [codebase overview](/codebase-overview.md) to understand the structure of the codebase and the conventions being followed.
+Read the [codebase overview](./codebase-overview.md) to understand the structure of the codebase and the conventions being followed.
 
 If you need to create a new component, run the scaffolding script to generate the basic folder structure, React component, 
 documentation, and base unit tests for a new component. 

diff --git a/guide/design/colour.md b/guide/design/colour.md
@@ -126,7 +126,7 @@ Sass: $color-panache</code></pre>
 ## Governance
 
 The TELUS digital colour palette is mandated by the TELUS Brand team and should not be adjusted without explicit approval. If 
-you should have any questions regarding implementation, please [get in touch with us](/contact.md).
+you should have any questions regarding implementation, please [get in touch with us](../contact.md).
 
 ## Roadmap
 

diff --git a/guide/design/dividers.md b/guide/design/dividers.md
@@ -23,7 +23,7 @@ See the [Divider components](ref:///components/index.html#dividers) for implemen
 ## Governance
 
 The dividers are managed by the Design Strategy team and we are currently not accepting any further contributions at this 
-time. However If you have any ideas, improvements or any questions regarding implementation please [get in touch with us](/contact.md).
+time. However If you have any ideas, improvements or any questions regarding implementation please [get in touch with us](../contact.md).
 
 
 ## Roadmap

diff --git a/guide/design/imagery.md b/guide/design/imagery.md
@@ -29,7 +29,7 @@ See the [Image component](ref:///components/index.html#image) for implementation
 ## Governance
 
 The TELUS Imagery guidelines and Brand Hub microsite are managed by the TELUS Brand team and should be strictly followed 
-unless explicit approval has been granted. If you have any questions regarding implementation please [get in touch with us](/contact.md).
+unless explicit approval has been granted. If you have any questions regarding implementation please [get in touch with us](../contact.md).
 
 
 ## Roadmap

diff --git a/guide/design/layout.md b/guide/design/layout.md
@@ -17,7 +17,7 @@ See the following components for implementation details:
 
 ## Governance
 
-The layout system is managed by the Design Strategy team and we are open to improvements and contributions. If you have any ideas, suggestions or questions regarding implementation please [get in touch with us](/contact.md).
+The layout system is managed by the Design Strategy team and we are open to improvements and contributions. If you have any ideas, suggestions or questions regarding implementation please [get in touch with us](../contact.md).
 
 
 ## Roadmap

diff --git a/guide/design/typography.md b/guide/design/typography.md
@@ -52,7 +52,7 @@ See the [Typography components](ref:///components/index.html#typography) for imp
 ## Governance
 
 The typography is mandated by the TELUS Brand team and should not be adjusted without explicit approval. If you would 
-have any questions regarding implementation please [get in touch with us](/contact.md).
+have any questions regarding implementation please [get in touch with us](../contact.md).
 
 
 ## Roadmap

diff --git a/guide/getting-started/designers.md b/guide/getting-started/designers.md
@@ -165,4 +165,4 @@ The TELUS Design System team often makes improvements to the TDS component libra
 
 # Support
 
-Please take the time to join our [#TDS-Guild Slack channel](https://telusdigital.slack.com/messages/C2WK9TP5F). It's the perfect place for general discussions, announcements, and design questions related to TDS. For further help please see our [Support Page](/contact.html)
+Please take the time to join our [#TDS-Guild Slack channel](https://telusdigital.slack.com/messages/C2WK9TP5F). It's the perfect place for general discussions, announcements, and design questions related to TDS. For further help please see our [Support Page](../contact.html)
diff --git a/guide/getting-started/developers.md b/guide/getting-started/developers.md
@@ -17,7 +17,7 @@ TDS components do not include:
 
 ## Installing
 
-If you are using the [Isomorphic Starter Kit](https://github.com/telusdigital/telus-isomorphic-starter-kit), TDS is already installed and configured. You can jump straight to [using the components](#use-components).
+If you are using the [Isomorphic Starter Kit](https://github.com/telusdigital/telus-isomorphic-starter-kit), TDS is already installed and configured. You can jump straight to [using the components](#3-use-tds-components).
 
 To install the latest version:
 
@@ -80,7 +80,7 @@ render(
 );
 ```
 
-### 3. Use TDS Components {#use-components}
+### 3. Use TDS Components
 
 TDS components are made to be composed. Each one accomplishes a specific purpose. Combine them to create more complex components for your application.
 
@@ -107,7 +107,7 @@ export default BannerText
 
 Colour is the one exception, as the colour palette is available as Sass variables. While the TDS components already have colour baked in, you may use the TDS colour variables to add style to your own components such as setting background colours or border colours.
 
-A list of the available colours and their use cases can be found [in the Design section](/design/colour.md).
+A list of the available colours and their use cases can be found [in the Design section](../design/colour.md).
 
 ```scss
 // BannerText.scss

diff --git a/guide/getting-started/faq.md b/guide/getting-started/faq.md
@@ -6,7 +6,7 @@ The design system must strike a balance between flexibility and consistency. If
 
 If your design shows a component being used in a way that does not match what is available in code, it may be either a mistake in the design, or a feature that has not yet been coded.
 
-Either way, [let us know about it](/contact.md) so that we can work with you on the appropriate solution.
+Either way, [let us know about it](../contact.md) so that we can work with you on the appropriate solution.
 
 
 ## How is TDS versioned?
@@ -21,7 +21,7 @@ In short:
 
 While TDS is currently structured as a single package, we intend to separate each component into its own independently versioned package soon. We hope this will make it even easier to manage upgrades across independent components.
 
-Learn more by reading the [TELUS Design Platform roadmap](/roadmap.md).
+Learn more by reading the [TELUS Design Platform roadmap](../roadmap.md).
 
 
 ## What browsers does TDS support?

diff --git a/guide/roadmap.md b/guide/roadmap.md
@@ -67,6 +67,6 @@ and [html-sketchapp](https://github.com/brainly/html-sketchapp)
 
 We continuously tune the plan based on feedback and priorities. Please follow along and let us know what you think!
 
-Learn [how to contribute](/contributing/contributing.md) and discuss features.
+Learn [how to contribute](./contributing/contributing.md) and discuss features.
 
 [Reach out to us](contact.md)!