Skip to content

Commit

Permalink
Merge pull request #276 from mobi/chore_remove_gosheets_references_in…
Browse files Browse the repository at this point in the history
…_docs

[Chore] Removed Gosheets References from Documentation
  • Loading branch information
grahamhency authored Oct 15, 2019
2 parents 61ee914 + 80b2bc8 commit 57b6472
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 89 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,24 @@ <h2 class="go-heading-4">Step 0: Before You Go</h2>
</p>
<ul class="go-list">
<li>You have Node installed</li>
<li>You have Angular installed (for goponents)</li>
<li>You have Angular installed</li>
<li>You're ulitizing SCSS</li>
</ul>
</section>
<p class="go-column go-column--100">
The current iteration of our design system is made up of two node modules:
The current iteration of our design system is made up of a single node module:
</p>
<section class="go-column go-column--100">
<section class="go-column go-column--100 go-column--no-padding">
<p class="go-body-copy">
<strong>@tangoe/goponents</strong>
(<a class="go-link" href="https://www.npmjs.com/package/@tangoe/goponents">npmjs</a> /
<a class="go-link" href="https://github.com/mobi/goponents">GitHub</a>)
</p>
<p class="go-body-copy">
This package contains all of the custom Angular Components and Services
outlined in the <a class="go-link" routerLink="./ui-kit">Components</a>
section of this Style Guide.
This package contains all of the custom Angular Components, Services, and styles
outlined in this Style Guide.
</p>
</section>
<section class="go-column go-column--100 go-column--no-padding">
<p class="go-body-copy">
<strong>@tangoe/gosheets</strong>
(<a class="go-link" href="https://www.npmjs.com/package/@tangoe/gosheets">npmjs</a> /
<a class="go-link" href="https://github.com/mobi/gosheets">GitHub</a>)
</p>
<p class="go-body-copy">
This package contains all of the global styles for the Go Design. Items included
in this package are:
</p>
<ul class="go-list">
<li>Color/Setting Variables</li>
<li>Various SCSS Mixins</li>
<li>Grid System</li>
<li>Form Styles</li>
<li>Type Styles</li>
</ul>
</section>
</div>
</ng-container>
</go-card>
Expand All @@ -61,36 +42,13 @@ <h2 class="go-heading-4">Step 1: Installation</h2>
<ng-container go-card-content>
<div class="go-container">
<p class="go-column go-column--100">
Both goponents & gosheets are open source projects and can easily be installed through NPM.
Goponents is an open source project and can easily be installed through NPM.
</p>
<section class="go-column go-column--100">
<section class="go-column go-column--100 go-column--no-padding">
<h6 class="go-heading-6">
Install goponents:
</h6>
<code [highlight]="installGoponents" [languages]="['bash']"></code>
<h6 class="go-heading-6">
Install gosheets:
</h6>
<code [highlight]="installGosheets" [languages]="['bash']"></code>
</section>
<section class="go-column go-column--100">
<h3 class="go-heading-5">Hey, Listen!</h3>
<p class="go-body-copy">
The latest version of goponents may not always have a dependency of the
latest version of gosheets. To avoid problems, install goponents first and look
for the warning output from NPM about peer dependency requirements.
</p>
<p class="go-body-copy">
Alternatively, you can check for the version of <code class="code-block--inline">@tangoe/gosheets</code>
on the <code class="code-block--inline">devDependencies</code> object in
<code class="code-block--inline">./node_modules/@tangoe/goponents/package.json</code>
</p>
</section>
<section class="go-column go-column--100 go-column--no-padding">
<p class="go-body-copy">
After discovering the version requirements, install that version specifically:
</p>
<code [highlight]="installGosheetsVersion" [languages]="['bash']"></code>
</section>
</div>
</ng-container>
Expand All @@ -102,9 +60,9 @@ <h2 class="go-heading-4">Step 2: Setup</h2>
<ng-container go-card-content>
<div class="go-container">
<section class="go-column go-column--100">
<h3 class="go-heading-5">Goponents</h3>
<h3 class="go-heading-5">Components</h3>
<p class="go-body-copy">
For goponents, the setup will depend upon which component you need to implement.
For components, the setup will depend upon which one you need to implement.
To find that information, check each components' documenation for instructions.
Typically it involves importing the specific module for each component you use.
</p>
Expand All @@ -113,17 +71,17 @@ <h3 class="go-heading-5">Goponents</h3>
import what is needed for each module.
</p>
</section>
<section class="go-column go-column--100">
<h3 class="go-heading-5">Gosheets</h3>
<section class="go-column go-column--100 go-column--no-padding">
<h3 class="go-heading-5">Styles</h3>
<p class="go-body-copy">
To utlize all of the benefits gosheets has to offer, in the root <code class="code-block--inline">styles.scss</code>
To utlize all of the benefits our styles have to offer, in the root <code class="code-block--inline">styles.scss</code>
of the project import:
</p>
<code [highlight]="importGosheetsBase"></code>
<code [highlight]="importStylesBase"></code>
<p class="go-body-copy">
Alternatively, partials can be imported individually. These can be found:
</p>
<code [highlight]="importGosheetsPartials"></code>
<code [highlight]="importStylesPartials"></code>
</section>
</div>
</ng-container>
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ import { Component } from '@angular/core';
export class GettingStartedComponent {

installGoponents: string = `npm install @tangoe/goponents`;
installGosheets: string = `npm install @tangoe/gosheets`;
installGosheetsVersion: string = `npm install @tangoe/[email protected]`;
importGosheetsBase: string = `@import "~@tangoe/gosheets/gosheets"`;
importGosheetsPartials: string = `@import "~@tangoe/gosheets/base/*"`;
importStylesBase: string = `@import "~@tangoe/goponents/styles/styles"`;
importStylesPartials: string = `@import "~@tangoe/goponents/styles/*"`;

constructor() { }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ <h1 class="go-heading-4">SASS Color Variables</h1>
<ng-container go-card-content>
<p class="go-body-copy">
All of the available sass variables for theming, branding, & other
UI states are available via the gosheets package.
If the gosheets package is installed, these can be imported in an
scss file with:
<code class="code-block--inline">@import '~@tangoe/gosheets/base/variables';</code>
UI states are available via the goponents package.
These can be imported in a scss file with:
<code class="code-block--inline">@import '~@tangoe/goponents/styles/variables';</code>
</p>
</ng-container>
</go-card>
Expand Down

0 comments on commit 57b6472

Please sign in to comment.