From d5a84ae5137783ad1084e6d6cebe2bf6597abaf5 Mon Sep 17 00:00:00 2001 From: Jeffrey Dowdle Date: Tue, 27 Jun 2023 11:17:33 +1000 Subject: [PATCH] docs(docs): cleaned up modules section content and added core module listing --- docs/content/framework/4.core-modules.md | 40 ++++++++++++++++ .../framework/4.modules/0.all-modules.md | 6 --- .../4.modules/1.core-ui-libraries.md | 19 -------- .../4.modules/2.core-content-types.md | 46 ------------------- .../@dpc-sdp-nuxt-ripple/_module.json | 13 ------ .../4.modules/@dpc-sdp-nuxt-ripple/index.md | 17 ------- .../@dpc-sdp-ripple-tide-event/_module.json | 12 ----- .../@dpc-sdp-ripple-tide-event/index.md | 17 ------- .../@dpc-sdp-ripple-tide-grant/_module.json | 12 ----- .../@dpc-sdp-ripple-tide-grant/index.md | 17 ------- .../_module.json | 12 ----- .../contents/components.md | 8 ---- .../index.md | 17 ------- .../usage.md | 8 ---- .../@dpc-sdp-ripple-tide-landing-page/wow.md | 8 ---- .../@dpc-sdp-ripple-tide-search/_module.json | 12 ----- .../@dpc-sdp-ripple-tide-search/index.md | 17 ------- .../@dpc-sdp-ripple-ui-core/_module.json | 12 ----- .../@dpc-sdp-ripple-ui-core/index.md | 17 ------- .../@dpc-sdp-ripple-ui-forms/_module.json | 12 ----- .../@dpc-sdp-ripple-ui-forms/index.md | 17 ------- 21 files changed, 40 insertions(+), 299 deletions(-) create mode 100644 docs/content/framework/4.core-modules.md delete mode 100644 docs/content/framework/4.modules/0.all-modules.md delete mode 100644 docs/content/framework/4.modules/1.core-ui-libraries.md delete mode 100644 docs/content/framework/4.modules/2.core-content-types.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/contents/components.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/usage.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/wow.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/index.md delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/_module.json delete mode 100644 docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/index.md diff --git a/docs/content/framework/4.core-modules.md b/docs/content/framework/4.core-modules.md new file mode 100644 index 0000000000..292a9c1411 --- /dev/null +++ b/docs/content/framework/4.core-modules.md @@ -0,0 +1,40 @@ +--- +title: Core modules +description: A listing of all current core Ripple layers and packages +layout: page +--- + +View each package on NPM for their individual READMEs. + +## Core UI Libraries + +- [`ripple-ui-core`](https://www.npmjs.com/package/@dpc-sdp/ripple-ui-core) +- [`ripple-ui-forms`](https://www.npmjs.com/package/@dpc-sdp/ripple-ui-forms) + +## Tide API + +- [`ripple-tide-api`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-api) + +## Nuxt-ripple base layer + +- [`nuxt-ripple`](https://www.npmjs.com/package/@dpc-sdp/nuxt-ripple) + +## Core content types + +- [`ripple-tide-landing-page`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-landing-page) +- [`ripple-tide-event`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-event) +- [`ripple-tide-grant`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-grant) +- [`ripple-tide-media`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-media) +- [`ripple-tide-news`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-news) +- [`ripple-tide-publication`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-publication) + +## Other core modules + +- [`ripple-tide-search`](https://www.npmjs.com/package/@dpc-sdp/ripple-tide-search) +- [`nuxt-ripple-analytics`](https://www.npmjs.com/package/@dpc-sdp/nuxt-ripple-analytics) +- [`nuxt-ripple-preview`](https://www.npmjs.com/package/@dpc-sdp/nuxt-ripple-preview) + +## Scaffolding, testing and supporting packages + +- [`nuxt-ripple-cli`](https://www.npmjs.com/package/@dpc-sdp/nuxt-ripple-cli) +- [`ripple-test-utils`](https://www.npmjs.com/package/@dpc-sdp/ripple-test-utils) diff --git a/docs/content/framework/4.modules/0.all-modules.md b/docs/content/framework/4.modules/0.all-modules.md deleted file mode 100644 index de1059de10..0000000000 --- a/docs/content/framework/4.modules/0.all-modules.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: All modules -description: 'some description' -layout: module-listing -draft: true ---- diff --git a/docs/content/framework/4.modules/1.core-ui-libraries.md b/docs/content/framework/4.modules/1.core-ui-libraries.md deleted file mode 100644 index 931bdd7197..0000000000 --- a/docs/content/framework/4.modules/1.core-ui-libraries.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Ripple UI Libraries -description: 'some description' -layout: page -draft: true ---- - -::DocsCardGrid - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-ui-core' - --- - :: - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-ui-forms' - --- - :: -:: diff --git a/docs/content/framework/4.modules/2.core-content-types.md b/docs/content/framework/4.modules/2.core-content-types.md deleted file mode 100644 index 4703e079c0..0000000000 --- a/docs/content/framework/4.modules/2.core-content-types.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Tide Content Types -description: 'some description' -layout: page -draft: true ---- - -## Shared - -::DocsCardGrid - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-nuxt-ripple' - --- - :: -:: - -## Content Types - -::DocsCardGrid - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-tide-landing-page' - --- - :: - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-tide-grant' - --- - :: - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-tide-event' - --- - :: -:: - -## Other - -::DocsCardGrid - ::DocsModuleCard - --- - moduleSlug: '@dpc-sdp-ripple-tide-search' - --- - :: -:: diff --git a/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/_module.json b/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/_module.json deleted file mode 100644 index c1df272c7e..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/_module.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Nuxt Ripple", - "description": "Nuxt layer for adding Ripple UI and shared functionality for setting up support for Tide content", - "packageName": "@dpc-sdp/nuxt-ripple", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/nuxt-ripple", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "readmePath": "./../../../../packages/nuxt-ripple/README.md", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/index.md b/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/index.md deleted file mode 100644 index 5cb3792fa7..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-nuxt-ripple/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Nuxt Ripple -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/_module.json deleted file mode 100644 index b81f506a5d..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Event Page", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-tide-event", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/index.md deleted file mode 100644 index c8b82415b5..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-event/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Event page -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/_module.json deleted file mode 100644 index e2903a1e53..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Grant Page", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-tide-grant", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/index.md deleted file mode 100644 index 5282b11f6c..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-grant/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Grant page -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/_module.json deleted file mode 100644 index bc8446aef3..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Landing Page", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-tide-landing", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/contents/components.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/contents/components.md deleted file mode 100644 index fa7930c4c1..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/contents/components.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Some page -description: 'some description' -layout: module ---- - -testing - diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/index.md deleted file mode 100644 index 83fbaf64c3..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Landing page -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/usage.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/usage.md deleted file mode 100644 index fa7930c4c1..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/usage.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Some page -description: 'some description' -layout: module ---- - -testing - diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/wow.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/wow.md deleted file mode 100644 index fa7930c4c1..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-landing-page/wow.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Some page -description: 'some description' -layout: module ---- - -testing - diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/_module.json deleted file mode 100644 index bc6c0868de..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Search", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-tide-search", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/index.md deleted file mode 100644 index 5282b11f6c..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-tide-search/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Grant page -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/_module.json deleted file mode 100644 index 2d9ec09ec2..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Ripple UI Core", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-ui-core", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/index.md deleted file mode 100644 index 83fbaf64c3..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-core/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Landing page -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -``` diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/_module.json b/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/_module.json deleted file mode 100644 index 5d323c407d..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/_module.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "isModuleInfo": true, - "name": "Ripple UI Forms", - "description": "Testing the description", - "packageName": "@dpc-sdp/ripple-ui-forms", - "sourceUrl": "https://github.com/dpc-sdp/ripple-framework/tree/develop/packages/ripple-tide-landing-page", - "issuesUrl": "https://github.com/dpc-sdp/ripple-framework/issues", - "contributor": { - "name": "SDP", - "url": "https://www.vic.gov.au/single-digital-presence" - } -} diff --git a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/index.md b/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/index.md deleted file mode 100644 index e25e4d439e..0000000000 --- a/docs/content/framework/4.modules/@dpc-sdp-ripple-ui-forms/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Ripple UI Forms -description: 'Allows the creation of many different pages through dynamic components' -layout: module ---- - -## Overview - -Landing page template Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. - -![Landing page content type](/assets/img/modules/Landing-Page.png) - -This is what it is - -```js -Some code -```