diff --git a/apps/daffio/src/app/app-routing.module.ts b/apps/daffio/src/app/app-routing.module.ts index def35ff258..3598f98446 100644 --- a/apps/daffio/src/app/app-routing.module.ts +++ b/apps/daffio/src/app/app-routing.module.ts @@ -58,7 +58,7 @@ export const appRoutes: Routes = [ { path: '', children: [ - { path: 'guides', loadChildren: () => import('./guides/guides.module').then(m => m.DaffioGuidesModule) }, + { path: 'packages', loadChildren: () => import('./packages/packages.module').then(m => m.DaffioPackagesModule) }, ], data: { daffNamedViews: { diff --git a/apps/daffio/src/app/core/footer/footer/footer.component.ts b/apps/daffio/src/app/core/footer/footer/footer.component.ts index c5290cbf90..a2d3b66194 100644 --- a/apps/daffio/src/app/core/footer/footer/footer.component.ts +++ b/apps/daffio/src/app/core/footer/footer/footer.component.ts @@ -22,7 +22,7 @@ export class DaffioFooterComponent { links: any[] = [ { path: '/why-pwa', title: 'Why PWA' }, - { path: '/api', title: 'Docs' }, + { path: '/packages', title: 'Docs' }, { path: '/support', title: 'Support' }, ]; diff --git a/apps/daffio/src/app/core/footer/simple-footer/simple-footer.component.ts b/apps/daffio/src/app/core/footer/simple-footer/simple-footer.component.ts index 155ba73b0c..0af310dd9c 100644 --- a/apps/daffio/src/app/core/footer/simple-footer/simple-footer.component.ts +++ b/apps/daffio/src/app/core/footer/simple-footer/simple-footer.component.ts @@ -22,7 +22,7 @@ export class DaffioSimpleFooterComponent { links: any[] = [ { path: '/why-pwa', title: 'Why PWA' }, - { path: '/api', title: 'Docs' }, + { path: '/packages', title: 'Docs' }, { path: '/support', title: 'Support' }, ]; diff --git a/apps/daffio/src/app/core/header/containers/docs-header/docs-header.component.ts b/apps/daffio/src/app/core/header/containers/docs-header/docs-header.component.ts index 76554b9308..c73f7bd8cb 100644 --- a/apps/daffio/src/app/core/header/containers/docs-header/docs-header.component.ts +++ b/apps/daffio/src/app/core/header/containers/docs-header/docs-header.component.ts @@ -17,7 +17,7 @@ export class DaffioDocsHeaderContainer { faBars = faBars; links: any[] = [ - { path: '/guides', title: 'Packages' }, + { path: '/packages', title: 'Packages' }, { path: '/api', title: 'API Index' }, ]; diff --git a/apps/daffio/src/app/core/header/containers/marketing-header/marketing-header.component.ts b/apps/daffio/src/app/core/header/containers/marketing-header/marketing-header.component.ts index f6f518c81e..add749f97d 100644 --- a/apps/daffio/src/app/core/header/containers/marketing-header/marketing-header.component.ts +++ b/apps/daffio/src/app/core/header/containers/marketing-header/marketing-header.component.ts @@ -18,7 +18,7 @@ export class DaffioMarketingHeaderContainer { links: any[] = [ { path: '/why-pwa', title: 'Why PWA' }, - { path: '/api', title: 'Docs' }, + { path: '/packages', title: 'Docs' }, ]; constructor(private store: Store) { } diff --git a/apps/daffio/src/app/core/sidebar/components/docs-sidebar-content/docs-sidebar-content.component.ts b/apps/daffio/src/app/core/sidebar/components/docs-sidebar-content/docs-sidebar-content.component.ts index 83f3cd3235..5dfe724a8b 100644 --- a/apps/daffio/src/app/core/sidebar/components/docs-sidebar-content/docs-sidebar-content.component.ts +++ b/apps/daffio/src/app/core/sidebar/components/docs-sidebar-content/docs-sidebar-content.component.ts @@ -11,7 +11,7 @@ import { }) export class DaffioDocsSidebarContentComponent { links: any[] = [ - { path: '/guides', title: 'Packages' }, + { path: '/packages', title: 'Packages' }, { path: '/api', title: 'API Index' }, ]; } diff --git a/apps/daffio/src/app/core/sidebar/components/marketing-sidebar-content/marketing-sidebar-content.component.ts b/apps/daffio/src/app/core/sidebar/components/marketing-sidebar-content/marketing-sidebar-content.component.ts index a235a936d6..16f4ce5248 100644 --- a/apps/daffio/src/app/core/sidebar/components/marketing-sidebar-content/marketing-sidebar-content.component.ts +++ b/apps/daffio/src/app/core/sidebar/components/marketing-sidebar-content/marketing-sidebar-content.component.ts @@ -12,6 +12,6 @@ import { export class DaffioMarketingSidebarContentComponent { links: any[] = [ { path: '/why-pwa', title: 'Why PWA' }, - { path: '/api', title: 'Docs' }, + { path: '/packages', title: 'Docs' }, ]; } diff --git a/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.component.spec.ts b/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.component.spec.ts index e5cd055b6e..9ec5ace770 100644 --- a/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.component.spec.ts +++ b/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.component.spec.ts @@ -15,7 +15,6 @@ import { MockStore, provideMockStore, } from '@ngrx/store/testing'; -import { DaffioDocsPackagesListContainerModule } from 'apps/daffio/src/app/guides/containers/packages-list/packages-list.module'; import { BehaviorSubject } from 'rxjs'; import { DaffBreakpoints } from '@daffodil/design'; @@ -24,6 +23,7 @@ import { DAFFIO_DOCS_CONTENT_SIDEBAR_KIND, DaffioDocsSidebarContainer, } from './docs-sidebar.component'; +import { DaffioDocsPackagesListContainerModule } from '../../../../packages/containers/packages-list/packages-list.module'; import { DaffioDocsSidebarContentComponentModule } from '../../components/docs-sidebar-content/docs-sidebar-content.module'; import { selectSidebarKind } from '../../reducers'; diff --git a/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.module.ts b/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.module.ts index 2c6f1b2e82..5c94ba9551 100644 --- a/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.module.ts +++ b/apps/daffio/src/app/core/sidebar/containers/docs-sidebar/docs-sidebar.module.ts @@ -2,9 +2,9 @@ import { CommonModule } from '@angular/common'; import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; import { LetDirective } from '@ngrx/component'; -import { DaffioDocsPackagesListContainerModule } from 'apps/daffio/src/app/guides/containers/packages-list/packages-list.module'; import { DaffioDocsSidebarContainer } from './docs-sidebar.component'; +import { DaffioDocsPackagesListContainerModule } from '../../../../packages/containers/packages-list/packages-list.module'; import { DaffioDocsSidebarContentComponentModule } from '../../components/docs-sidebar-content/docs-sidebar-content.module'; @NgModule({ diff --git a/apps/daffio/src/app/core/sidebar/sidebar.module.ts b/apps/daffio/src/app/core/sidebar/sidebar.module.ts index d242c87f5c..d251fef8c0 100644 --- a/apps/daffio/src/app/core/sidebar/sidebar.module.ts +++ b/apps/daffio/src/app/core/sidebar/sidebar.module.ts @@ -9,7 +9,7 @@ import { DaffRouterNamedViewOutletModule } from '@daffodil/router'; import { DaffioSidebarViewportContainer } from './containers/sidebar-viewport/sidebar-viewport.component'; import { DaffioSidebarStateModule } from './sidebar.state.module'; -import { DaffioDocsPackagesListContainerModule } from '../../guides/containers/packages-list/packages-list.module'; +import { DaffioDocsPackagesListContainerModule } from '../../packages/containers/packages-list/packages-list.module'; @NgModule({ imports: [ diff --git a/apps/daffio/src/app/docs/models/guide-list.ts b/apps/daffio/src/app/docs/models/guide-list.ts deleted file mode 100644 index 4e0fe4001e..0000000000 --- a/apps/daffio/src/app/docs/models/guide-list.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface DaffioGuideList { - id: string; - title: string; - path?: string; - children?: DaffioGuideList[]; -} - - diff --git a/apps/daffio/src/app/docs/models/packages-list.ts b/apps/daffio/src/app/docs/models/packages-list.ts new file mode 100644 index 0000000000..0bcc4d3f6e --- /dev/null +++ b/apps/daffio/src/app/docs/models/packages-list.ts @@ -0,0 +1,8 @@ +export interface DaffioPackagesList { + id: string; + title: string; + path?: string; + children?: DaffioPackagesList[]; +} + + diff --git a/apps/daffio/src/app/docs/resolvers/docs-resolver.service.spec.ts b/apps/daffio/src/app/docs/resolvers/docs-resolver.service.spec.ts index 629b0cd7e8..f355abffa7 100644 --- a/apps/daffio/src/app/docs/resolvers/docs-resolver.service.spec.ts +++ b/apps/daffio/src/app/docs/resolvers/docs-resolver.service.spec.ts @@ -13,18 +13,18 @@ import { import { DocsResolver } from './docs-resolver.service'; import { DaffioDoc } from '../models/doc'; -import { DaffioGuideList } from '../models/guide-list'; +import { DaffioPackagesList } from '../models/packages-list'; import { DaffioDocsServiceInterface } from '../services/docs-service.interface'; import { DaffioDocsService } from '../services/docs.service'; import { DaffioDocsFactory } from '../testing/factories/docs.factory'; describe('DocsResolver', () => { - let resolver: DocsResolver; - let docsService: DaffioDocsService; + let resolver: DocsResolver; + let docsService: DaffioDocsService; let router: Router; const doc = new DaffioDocsFactory().create(); - const stubDocService: DaffioDocsServiceInterface = { + const stubDocService: DaffioDocsServiceInterface = { get: (path: string): Observable => of(doc), getGuideList: () => of(), }; diff --git a/apps/daffio/src/app/docs/resolvers/docs-resolver.service.ts b/apps/daffio/src/app/docs/resolvers/docs-resolver.service.ts index cb8fb8dacd..8eb83b275a 100644 --- a/apps/daffio/src/app/docs/resolvers/docs-resolver.service.ts +++ b/apps/daffio/src/app/docs/resolvers/docs-resolver.service.ts @@ -19,13 +19,13 @@ import { } from '@daffodil/core/routing'; import { DaffioDoc } from '../models/doc'; -import { DaffioGuideList } from '../models/guide-list'; +import { DaffioPackagesList } from '../models/packages-list'; import { DaffioDocsService } from '../services/docs.service'; @Injectable({ providedIn: 'root', }) -export class DocsResolver { +export class DocsResolver { constructor(private docService: DaffioDocsService, private router: Router) { } diff --git a/apps/daffio/src/app/docs/services/docs-service.interface.ts b/apps/daffio/src/app/docs/services/docs-service.interface.ts index 78cbb76879..47ac81888f 100644 --- a/apps/daffio/src/app/docs/services/docs-service.interface.ts +++ b/apps/daffio/src/app/docs/services/docs-service.interface.ts @@ -1,10 +1,9 @@ import { Observable } from 'rxjs'; import { DaffioDoc } from '../models/doc'; -import { DaffioDocList } from '../models/doc-list'; -import { DaffioGuideList } from '../models/guide-list'; +import { DaffioPackagesList } from '../models/packages-list'; -export interface DaffioDocsServiceInterface { +export interface DaffioDocsServiceInterface { get(path: string): Observable; getGuideList(): Observable; } diff --git a/apps/daffio/src/app/docs/services/docs.service.spec.ts b/apps/daffio/src/app/docs/services/docs.service.spec.ts index 6d6f2d96f8..f8aee755c4 100644 --- a/apps/daffio/src/app/docs/services/docs.service.spec.ts +++ b/apps/daffio/src/app/docs/services/docs.service.spec.ts @@ -7,15 +7,15 @@ import { DaffioAssetFetchServiceInterface, } from '../../core/assets/fetch/service.interface'; import { DaffioDoc } from '../models/doc'; -import { DaffioGuideList } from '../models/guide-list'; +import { DaffioPackagesList } from '../models/packages-list'; import { DaffioDocsFactory } from '../testing/factories/docs.factory'; -import { mockGuides } from '../testing/factories/guide-list.factory'; +import { mockPackages } from '../testing/factories/packages-list.factory'; describe('DaffioDocsService', () => { - let service: DaffioDocsService; + let service: DaffioDocsService; let fetchAssetServiceSpy: jasmine.SpyObj; let doc: DaffioDoc; - const mockGuideList = mockGuides; + const mockGuideList = mockPackages; beforeEach(() => { fetchAssetServiceSpy = jasmine.createSpyObj('DaffioAssetFetchService', ['fetch']); @@ -53,7 +53,7 @@ describe('DaffioDocsService', () => { service.getGuideList().subscribe((guides) => { expect(guides).toEqual(mockGuideList); - expect(fetchAssetServiceSpy.fetch).toHaveBeenCalledWith('/assets/daffio/docs/guides/guide-list.json'); + expect(fetchAssetServiceSpy.fetch).toHaveBeenCalledWith('/assets/daffio/docs/packages/guide-list.json'); done(); }); }); diff --git a/apps/daffio/src/app/docs/services/docs.service.ts b/apps/daffio/src/app/docs/services/docs.service.ts index c0fd4547d0..2dc9594cea 100644 --- a/apps/daffio/src/app/docs/services/docs.service.ts +++ b/apps/daffio/src/app/docs/services/docs.service.ts @@ -13,12 +13,12 @@ import { DaffioAssetFetchServiceInterface, } from '../../core/assets/fetch/service.interface'; import { DaffioDoc } from '../models/doc'; -import { DaffioGuideList } from '../models/guide-list'; +import { DaffioPackagesList } from '../models/packages-list'; @Injectable({ providedIn: 'root', }) -export class DaffioDocsService implements DaffioDocsServiceInterface { +export class DaffioDocsService implements DaffioDocsServiceInterface { constructor( @Inject(DaffioAssetFetchService) private fetchAsset: DaffioAssetFetchServiceInterface, @@ -30,6 +30,6 @@ export class DaffioDocsService { - return this.fetchAsset.fetch(`${this.docsPath}guides/guide-list.json`); + return this.fetchAsset.fetch(`${this.docsPath}packages/guide-list.json`); } } diff --git a/apps/daffio/src/app/docs/testing/factories/guide-list.factory.ts b/apps/daffio/src/app/docs/testing/factories/packages-list.factory.ts similarity index 73% rename from apps/daffio/src/app/docs/testing/factories/guide-list.factory.ts rename to apps/daffio/src/app/docs/testing/factories/packages-list.factory.ts index a7c31dc35c..0cc39f8f51 100644 --- a/apps/daffio/src/app/docs/testing/factories/guide-list.factory.ts +++ b/apps/daffio/src/app/docs/testing/factories/packages-list.factory.ts @@ -1,6 +1,6 @@ -import { DaffioGuideList } from '../../models/guide-list'; +import { DaffioPackagesList } from '../../models/packages-list'; -export const mockGuides: DaffioGuideList = { +export const mockPackages: DaffioPackagesList = { id: '', title: '', children: [ @@ -12,19 +12,19 @@ export const mockGuides: DaffioGuideList = { id: '', title: 'Overview', children: [], - path: 'guides/cart', + path: 'packages/cart', }, { id: 'install', title: 'Installation', children: [], - path: 'guides/cart/install', + path: 'packages/cart/install', }, { id: 'testing', title: 'Testing', children: [], - path: 'guides/cart/testing', + path: 'packages/cart/testing', }, ], }, @@ -32,19 +32,19 @@ export const mockGuides: DaffioGuideList = { id: 'category', title: '@daffodil/category', children: [], - path: 'guides/category', + path: 'packages/category', }, { id: 'checkout', title: '@daffodil/checkout', children: [], - path: 'guides/checkout', + path: 'packages/checkout', }, { id: 'core', title: '@daffodil/core', children: [], - path: 'guides/core', + path: 'packages/core', }, { id: 'design', @@ -54,7 +54,7 @@ export const mockGuides: DaffioGuideList = { id: '', title: 'Overview', children: [], - path: 'guides/design', + path: 'packages/design', }, { id: 'theming', @@ -64,7 +64,7 @@ export const mockGuides: DaffioGuideList = { id: 'installation', title: 'Daffodil Theming Installation Guide', children: [], - path: 'guides/design/theming/installation', + path: 'packages/design/theming/installation', }, ], }, @@ -78,13 +78,13 @@ export const mockGuides: DaffioGuideList = { id: '', title: 'Overview', children: [], - path: 'guides/product', + path: 'packages/product', }, { id: 'in-memory-driver', title: 'Using the InMemory Driver', children: [], - path: 'guides/product/in-memory-driver', + path: 'packages/product/in-memory-driver', }, ], }, diff --git a/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.html b/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.html deleted file mode 100644 index c3b058c7f7..0000000000 --- a/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.html +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/apps/daffio/src/app/guides/pages/guides-page.component.html b/apps/daffio/src/app/guides/pages/guides-page.component.html deleted file mode 100644 index a8b833e9cc..0000000000 --- a/apps/daffio/src/app/guides/pages/guides-page.component.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/apps/daffio/src/app/guides/components/package-cards/package-cards.component.html b/apps/daffio/src/app/packages/components/package-cards/package-cards.component.html similarity index 100% rename from apps/daffio/src/app/guides/components/package-cards/package-cards.component.html rename to apps/daffio/src/app/packages/components/package-cards/package-cards.component.html diff --git a/apps/daffio/src/app/guides/components/package-cards/package-cards.component.scss b/apps/daffio/src/app/packages/components/package-cards/package-cards.component.scss similarity index 100% rename from apps/daffio/src/app/guides/components/package-cards/package-cards.component.scss rename to apps/daffio/src/app/packages/components/package-cards/package-cards.component.scss diff --git a/apps/daffio/src/app/guides/components/package-cards/package-cards.component.spec.ts b/apps/daffio/src/app/packages/components/package-cards/package-cards.component.spec.ts similarity index 100% rename from apps/daffio/src/app/guides/components/package-cards/package-cards.component.spec.ts rename to apps/daffio/src/app/packages/components/package-cards/package-cards.component.spec.ts diff --git a/apps/daffio/src/app/guides/components/package-cards/package-cards.component.ts b/apps/daffio/src/app/packages/components/package-cards/package-cards.component.ts similarity index 100% rename from apps/daffio/src/app/guides/components/package-cards/package-cards.component.ts rename to apps/daffio/src/app/packages/components/package-cards/package-cards.component.ts diff --git a/apps/daffio/src/app/guides/components/package-cards/package-cards.module.ts b/apps/daffio/src/app/packages/components/package-cards/package-cards.module.ts similarity index 100% rename from apps/daffio/src/app/guides/components/package-cards/package-cards.module.ts rename to apps/daffio/src/app/packages/components/package-cards/package-cards.module.ts diff --git a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.html b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.html similarity index 55% rename from apps/daffio/src/app/guides/components/packages-list/packages-list.component.html rename to apps/daffio/src/app/packages/components/packages-list/packages-list.component.html index 4c3f8eed6d..0749856acf 100644 --- a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.html +++ b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.html @@ -1,9 +1,9 @@ \ No newline at end of file diff --git a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.spec.ts b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.spec.ts similarity index 98% rename from apps/daffio/src/app/guides/components/packages-list/packages-list.component.spec.ts rename to apps/daffio/src/app/packages/components/packages-list/packages-list.component.spec.ts index aa7fe504c8..1c61109f53 100644 --- a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.spec.ts +++ b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.spec.ts @@ -49,7 +49,7 @@ describe('DaffioDocsPackagesListComponent', () => { ], }; - component.guideList = { + component.packagesList = { id: 'root', title: 'root', children: [ diff --git a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.ts b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.ts similarity index 68% rename from apps/daffio/src/app/guides/components/packages-list/packages-list.component.ts rename to apps/daffio/src/app/packages/components/packages-list/packages-list.component.ts index 0e23d70630..42f9cffa01 100644 --- a/apps/daffio/src/app/guides/components/packages-list/packages-list.component.ts +++ b/apps/daffio/src/app/packages/components/packages-list/packages-list.component.ts @@ -10,9 +10,9 @@ import { daffTransformTreeInPlace, } from '@daffodil/design/tree'; -import { DaffioGuideList } from '../../../docs/models/guide-list'; +import { DaffioPackagesList } from '../../../docs/models/packages-list'; -const visit = (guide: DaffioGuideList): DaffTreeData => ({ +const visit = (guide: DaffioPackagesList): DaffTreeData => ({ id: guide.id, title: guide.title, url: guide.path, @@ -27,19 +27,19 @@ const visit = (guide: DaffioGuideList): DaffTreeData => ({ }) export class DaffioDocsPackagesListComponent { - _guideList: DaffioGuideList; + _packagesList: DaffioPackagesList; /** * The guide list to render */ @Input() - get guideList(): DaffioGuideList { - return this._guideList; + get packagesList(): DaffioPackagesList { + return this._packagesList; }; - set guideList(val: DaffioGuideList) { - if(this._guideList !== val) { + set packagesList(val: DaffioPackagesList) { + if(this._packagesList !== val) { this._tree = daffTransformTreeInPlace(val, visit, 'children'); } - this._guideList = val; + this._packagesList = val; } _tree: DaffTreeData; diff --git a/apps/daffio/src/app/guides/components/packages-list/packages-list.module.ts b/apps/daffio/src/app/packages/components/packages-list/packages-list.module.ts similarity index 100% rename from apps/daffio/src/app/guides/components/packages-list/packages-list.module.ts rename to apps/daffio/src/app/packages/components/packages-list/packages-list.module.ts diff --git a/apps/daffio/src/app/guides/containers/package-cards/package-cards.component.html b/apps/daffio/src/app/packages/containers/package-cards/package-cards.component.html similarity index 100% rename from apps/daffio/src/app/guides/containers/package-cards/package-cards.component.html rename to apps/daffio/src/app/packages/containers/package-cards/package-cards.component.html diff --git a/apps/daffio/src/app/guides/containers/package-cards/package-cards.component.spec.ts b/apps/daffio/src/app/packages/containers/package-cards/package-cards.component.spec.ts similarity index 100% rename from apps/daffio/src/app/guides/containers/package-cards/package-cards.component.spec.ts rename to apps/daffio/src/app/packages/containers/package-cards/package-cards.component.spec.ts diff --git a/apps/daffio/src/app/guides/containers/package-cards/package-cards.component.ts b/apps/daffio/src/app/packages/containers/package-cards/package-cards.component.ts similarity index 86% rename from apps/daffio/src/app/guides/containers/package-cards/package-cards.component.ts rename to apps/daffio/src/app/packages/containers/package-cards/package-cards.component.ts index b8422771ab..27dfa1a595 100644 --- a/apps/daffio/src/app/guides/containers/package-cards/package-cards.component.ts +++ b/apps/daffio/src/app/packages/containers/package-cards/package-cards.component.ts @@ -10,7 +10,7 @@ import { } from 'rxjs'; import { DaffioDoc } from '../../../docs/models/doc'; -import { DaffioGuideList } from '../../../docs/models/guide-list'; +import { DaffioPackagesList } from '../../../docs/models/packages-list'; import { DaffioDocsService } from '../../../docs/services/docs.service'; import { DaffioPackage } from '../../components/package-cards/package-cards.component'; @@ -24,7 +24,7 @@ export class DaffioDocsPackageCardsContainer implements OnInit { packagesList$: Observable; constructor( - private docService: DaffioDocsService, + private docService: DaffioDocsService, ) {} ngOnInit() { diff --git a/apps/daffio/src/app/guides/containers/package-cards/package-cards.module.ts b/apps/daffio/src/app/packages/containers/package-cards/package-cards.module.ts similarity index 100% rename from apps/daffio/src/app/guides/containers/package-cards/package-cards.module.ts rename to apps/daffio/src/app/packages/containers/package-cards/package-cards.module.ts diff --git a/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.html b/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.html new file mode 100644 index 0000000000..db15123a5f --- /dev/null +++ b/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.spec.ts b/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.spec.ts similarity index 100% rename from apps/daffio/src/app/guides/containers/packages-list/packages-list.component.spec.ts rename to apps/daffio/src/app/packages/containers/packages-list/packages-list.component.spec.ts diff --git a/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.ts b/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.ts similarity index 74% rename from apps/daffio/src/app/guides/containers/packages-list/packages-list.component.ts rename to apps/daffio/src/app/packages/containers/packages-list/packages-list.component.ts index 6ab342da11..998e5684c9 100644 --- a/apps/daffio/src/app/guides/containers/packages-list/packages-list.component.ts +++ b/apps/daffio/src/app/packages/containers/packages-list/packages-list.component.ts @@ -6,7 +6,7 @@ import { import { Observable } from 'rxjs'; import { DaffioDoc } from '../../../docs/models/doc'; -import { DaffioGuideList } from '../../../docs/models/guide-list'; +import { DaffioPackagesList } from '../../../docs/models/packages-list'; import { DaffioDocsService } from '../../../docs/services/docs.service'; @Component({ @@ -16,10 +16,10 @@ import { DaffioDocsService } from '../../../docs/services/docs.service'; }) export class DaffioDocsPackagesListContainer implements OnInit { - packagesList$: Observable; + packagesList$: Observable; constructor( - private docService: DaffioDocsService, + private docService: DaffioDocsService, ) {} ngOnInit() { diff --git a/apps/daffio/src/app/guides/containers/packages-list/packages-list.module.ts b/apps/daffio/src/app/packages/containers/packages-list/packages-list.module.ts similarity index 100% rename from apps/daffio/src/app/guides/containers/packages-list/packages-list.module.ts rename to apps/daffio/src/app/packages/containers/packages-list/packages-list.module.ts diff --git a/apps/daffio/src/app/guides/guides-routing.module.ts b/apps/daffio/src/app/packages/packages-routing.module.ts similarity index 78% rename from apps/daffio/src/app/guides/guides-routing.module.ts rename to apps/daffio/src/app/packages/packages-routing.module.ts index 885e110bd6..5269e71ab7 100644 --- a/apps/daffio/src/app/guides/guides-routing.module.ts +++ b/apps/daffio/src/app/packages/packages-routing.module.ts @@ -4,7 +4,7 @@ import { RouterModule, } from '@angular/router'; -import { DaffioGuidesPageComponent } from './pages/guides-page.component'; +import { DaffioPackagePageComponent } from './pages/package-page/package-page.component'; import { DaffioPackagesOverviewPageComponent } from './pages/packages-overview/packages-overview.component'; import { DocsResolver } from '../docs/resolvers/docs-resolver.service'; @@ -16,7 +16,7 @@ export const docsRoutes: Routes = [ }, { path: '**', - component: DaffioGuidesPageComponent, + component: DaffioPackagePageComponent, resolve: { doc: DocsResolver, }, @@ -34,4 +34,4 @@ export const docsRoutes: Routes = [ RouterModule, ], }) -export class DaffioGuidesRoutingModule { } +export class DaffioPackagesRoutingModule { } diff --git a/apps/daffio/src/app/guides/guides.module.ts b/apps/daffio/src/app/packages/packages.module.ts similarity index 74% rename from apps/daffio/src/app/guides/guides.module.ts rename to apps/daffio/src/app/packages/packages.module.ts index 50edb8c607..ef5cdaf8b6 100644 --- a/apps/daffio/src/app/guides/guides.module.ts +++ b/apps/daffio/src/app/packages/packages.module.ts @@ -6,8 +6,8 @@ import { DaffContainerModule } from '@daffodil/design/container'; import { DaffHeroModule } from '@daffodil/design/hero'; import { DaffioDocsPackageCardsContainerModule } from './containers/package-cards/package-cards.module'; -import { DaffioGuidesRoutingModule } from './guides-routing.module'; -import { DaffioGuidesPageComponent } from './pages/guides-page.component'; +import { DaffioPackagesRoutingModule } from './packages-routing.module'; +import { DaffioPackagePageComponent } from './pages/package-page/package-page.component'; import { DaffioPackagesOverviewPageComponent } from './pages/packages-overview/packages-overview.component'; import { DaffioDocViewerModule } from '../docs/components/doc-viewer/doc-viewer.module'; @@ -17,18 +17,18 @@ import { DaffioDocViewerModule } from '../docs/components/doc-viewer/doc-viewer. RouterModule, DaffioDocViewerModule, - DaffioGuidesRoutingModule, + DaffioPackagesRoutingModule, DaffContainerModule, DaffHeroModule, DaffioDocsPackageCardsContainerModule, ], declarations: [ - DaffioGuidesPageComponent, + DaffioPackagePageComponent, DaffioPackagesOverviewPageComponent, ], exports: [ - DaffioGuidesPageComponent, + DaffioPackagePageComponent, DaffioPackagesOverviewPageComponent, ], }) -export class DaffioGuidesModule {} +export class DaffioPackagesModule {} diff --git a/apps/daffio/src/app/packages/pages/package-page/package-page.component.html b/apps/daffio/src/app/packages/pages/package-page/package-page.component.html new file mode 100644 index 0000000000..0f48d7f159 --- /dev/null +++ b/apps/daffio/src/app/packages/pages/package-page/package-page.component.html @@ -0,0 +1 @@ + diff --git a/apps/daffio/src/app/guides/pages/guides-page.component.spec.ts b/apps/daffio/src/app/packages/pages/package-page/package-page.component.spec.ts similarity index 75% rename from apps/daffio/src/app/guides/pages/guides-page.component.spec.ts rename to apps/daffio/src/app/packages/pages/package-page/package-page.component.spec.ts index 9c58996f07..c8fdaaa2b7 100644 --- a/apps/daffio/src/app/guides/pages/guides-page.component.spec.ts +++ b/apps/daffio/src/app/packages/pages/package-page/package-page.component.spec.ts @@ -13,18 +13,18 @@ import { RouterTestingModule } from '@angular/router/testing'; import { cold } from 'jasmine-marbles'; import { BehaviorSubject } from 'rxjs'; -import { DaffioGuidesPageComponent } from './guides-page.component'; -import { DaffioDoc } from '../../docs/models/doc'; -import { DaffioDocsFactory } from '../../docs/testing/factories/docs.factory'; +import { DaffioPackagePageComponent } from './package-page.component'; +import { DaffioDoc } from '../../../docs/models/doc'; +import { DaffioDocsFactory } from '../../../docs/testing/factories/docs.factory'; @Component({ selector: 'daffio-doc-viewer', template: '' }) class MockDaffioDocViewerComponent { @Input() doc: DaffioDoc; } -describe('DaffioGuidesPageComponent', () => { - let component: DaffioGuidesPageComponent; - let fixture: ComponentFixture; +describe('DaffioPackagePageComponent', () => { + let component: DaffioPackagePageComponent; + let fixture: ComponentFixture; const doc: DaffioDoc = new DaffioDocsFactory().create(); const stubActivatedRoute = { data: new BehaviorSubject({}), @@ -33,7 +33,7 @@ describe('DaffioGuidesPageComponent', () => { beforeEach(waitForAsync(() => { TestBed.configureTestingModule({ declarations: [ - DaffioGuidesPageComponent, + DaffioPackagePageComponent, MockDaffioDocViewerComponent, ], imports: [ @@ -47,7 +47,7 @@ describe('DaffioGuidesPageComponent', () => { })); beforeEach(() => { - fixture = TestBed.createComponent(DaffioGuidesPageComponent); + fixture = TestBed.createComponent(DaffioPackagePageComponent); component = fixture.componentInstance; stubActivatedRoute.data.next({ doc }); fixture.detectChanges(); @@ -59,7 +59,7 @@ describe('DaffioGuidesPageComponent', () => { it('should initialize `doc$` to the resolved doc from the activated route', () => { const expected = cold('a', { a: doc }); - expect(component.guideDoc$).toBeObservable(expected); + expect(component.packageDoc$).toBeObservable(expected); }); it('should pass the down the observed doc to the `daffio-doc-viewer`', () => { diff --git a/apps/daffio/src/app/guides/pages/guides-page.component.ts b/apps/daffio/src/app/packages/pages/package-page/package-page.component.ts similarity index 51% rename from apps/daffio/src/app/guides/pages/guides-page.component.ts rename to apps/daffio/src/app/packages/pages/package-page/package-page.component.ts index 4e2ac19219..929696a659 100644 --- a/apps/daffio/src/app/guides/pages/guides-page.component.ts +++ b/apps/daffio/src/app/packages/pages/package-page/package-page.component.ts @@ -7,19 +7,20 @@ import { ActivatedRoute } from '@angular/router'; import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; -import { DaffioDoc } from '../../docs/models/doc'; +import { DaffioDoc } from '../../../docs/models/doc'; @Component({ - templateUrl: './guides-page.component.html', + selector: 'daffio-package-page', + templateUrl: './package-page.component.html', changeDetection: ChangeDetectionStrategy.OnPush, }) -export class DaffioGuidesPageComponent implements OnInit { +export class DaffioPackagePageComponent implements OnInit { - guideDoc$: Observable; + packageDoc$: Observable; constructor(private route: ActivatedRoute) { } ngOnInit() { - this.guideDoc$ = this.route.data.pipe(map((data: { doc: DaffioDoc }) => data.doc)); + this.packageDoc$ = this.route.data.pipe(map((data: { doc: DaffioDoc }) => data.doc)); } } diff --git a/apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.html b/apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.html similarity index 100% rename from apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.html rename to apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.html diff --git a/apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.scss b/apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.scss similarity index 100% rename from apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.scss rename to apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.scss diff --git a/apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.spec.ts b/apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.spec.ts similarity index 100% rename from apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.spec.ts rename to apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.spec.ts diff --git a/apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.ts b/apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.ts similarity index 100% rename from apps/daffio/src/app/guides/pages/packages-overview/packages-overview.component.ts rename to apps/daffio/src/app/packages/pages/packages-overview/packages-overview.component.ts diff --git a/tools/dgeni/src/transforms/daffodil-guides-package/index.ts b/tools/dgeni/src/transforms/daffodil-guides-package/index.ts index 5197858e05..35582548bb 100644 --- a/tools/dgeni/src/transforms/daffodil-guides-package/index.ts +++ b/tools/dgeni/src/transforms/daffodil-guides-package/index.ts @@ -30,7 +30,7 @@ export const guideDocPackage = new Package('daffodil-guides', [daffodilBasePacka convertToJson.docTypes = convertToJson.docTypes.concat(['guide']); }) .config((computePathsProcessor) => { - const DOCS_SEGMENT = 'guides'; + const DOCS_SEGMENT = 'packages'; computePathsProcessor.pathTemplates.push({ docTypes: ['guide'], getPath: (doc) =>{ diff --git a/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts b/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts index 77b3b740d8..d465967d19 100644 --- a/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts +++ b/tools/dgeni/src/transforms/daffodil-guides-package/processors/generateGuideList.ts @@ -11,7 +11,7 @@ export interface GenerateGuideListConfiguration { }; export const DefaultGenerateGuideListConfiguration: GenerateGuideListConfiguration = { - outputFolder: 'guides', + outputFolder: 'packages', }; export const transformGuideDoc = (doc: Document): TransformedDocument => ({