From 80b2bc8896ac72e80e84caf302d5fa1ed166676d Mon Sep 17 00:00:00 2001 From: Graham Hency Date: Mon, 14 Oct 2019 11:24:44 -0400 Subject: [PATCH] Removed gosheets references from documentation --- .../getting-started.component.html | 70 ++++--------------- .../getting-started.component.spec.ts | 25 ------- .../getting-started.component.ts | 6 +- .../components/colors/colors.component.html | 7 +- 4 files changed, 19 insertions(+), 89 deletions(-) delete mode 100644 projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.spec.ts diff --git a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.html b/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.html index 74b8be3be..cfe1f2630 100644 --- a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.html +++ b/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.html @@ -14,43 +14,24 @@

Step 0: Before You Go

- 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:

-
+

@tangoe/goponents (npmjs / GitHub)

- This package contains all of the custom Angular Components and Services - outlined in the Components - section of this Style Guide. + This package contains all of the custom Angular Components, Services, and styles + outlined in this Style Guide.

-
-

- @tangoe/gosheets - (npmjs / - GitHub) -

-

- This package contains all of the global styles for the Go Design. Items included - in this package are: -

-
    -
  • Color/Setting Variables
    • -
  • Various SCSS Mixins
    • -
  • Grid System
    • -
  • Form Styles
    • -
  • Type Styles
    • -
-
@@ -61,36 +42,13 @@

Step 1: Installation

- 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.

-
+
Install goponents:
-
- Install gosheets: -
- -
-
-

Hey, Listen!

-

- 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. -

-

- Alternatively, you can check for the version of @tangoe/gosheets - on the devDependencies object in - ./node_modules/@tangoe/goponents/package.json -

-
-
-

- After discovering the version requirements, install that version specifically: -

-
@@ -102,9 +60,9 @@

Step 2: Setup

-

Goponents

+

Components

- 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.

@@ -113,17 +71,17 @@

Goponents

import what is needed for each module.

-
-

Gosheets

+
+

Styles

- To utlize all of the benefits gosheets has to offer, in the root styles.scss + To utlize all of the benefits our styles have to offer, in the root styles.scss of the project import:

- +

Alternatively, partials can be imported individually. These can be found:

- +
diff --git a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.spec.ts b/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.spec.ts deleted file mode 100644 index 19747738e..000000000 --- a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.spec.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { async, ComponentFixture, TestBed } from '@angular/core/testing'; - -import { GettingStartedComponent } from './getting-started.component'; - -describe('GettingStartedComponent', () => { - let component: GettingStartedComponent; - let fixture: ComponentFixture; - - beforeEach(async(() => { - TestBed.configureTestingModule({ - declarations: [ GettingStartedComponent ] - }) - .compileComponents(); - })); - - beforeEach(() => { - fixture = TestBed.createComponent(GettingStartedComponent); - component = fixture.componentInstance; - fixture.detectChanges(); - }); - - it('should create', () => { - expect(component).toBeTruthy(); - }); -}); diff --git a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.ts b/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.ts index f809d02cb..8bfb30048 100644 --- a/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.ts +++ b/projects/go-style-guide/src/app/features/dashboard/components/getting-started/getting-started.component.ts @@ -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/gosheets@1.0.0`; - 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() { } diff --git a/projects/go-style-guide/src/app/features/standards/components/colors/colors.component.html b/projects/go-style-guide/src/app/features/standards/components/colors/colors.component.html index f3e3d4940..5b5328a58 100644 --- a/projects/go-style-guide/src/app/features/standards/components/colors/colors.component.html +++ b/projects/go-style-guide/src/app/features/standards/components/colors/colors.component.html @@ -10,10 +10,9 @@

SASS Color Variables

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: - @import '~@tangoe/gosheets/base/variables'; + UI states are available via the goponents package. + These can be imported in a scss file with: + @import '~@tangoe/goponents/styles/variables';