diff --git a/docs/360-portal/_category_.json b/docs/360-portal/_category_.json index ec2e9da..021d142 100644 --- a/docs/360-portal/_category_.json +++ b/docs/360-portal/_category_.json @@ -1,4 +1,4 @@ { - "label": "epilot portal", + "label": "360 Portal", "position": 4 } diff --git a/docs/entities/flexible-entities.md b/docs/entities/flexible-entities.md index 8fdc3ec..c851db6 100644 --- a/docs/entities/flexible-entities.md +++ b/docs/entities/flexible-entities.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 0 --- # Flexible Entities @@ -17,21 +17,9 @@ Each entity can contain arbitrary JSON data, which is made accessible via the En ## Schemas -Schemas represent different types of entities in epilot. +Schemas are used to define the structure of entities and how they are represented in the UI. -Examples of Entity Schemas: - -- Contact -- Account -- Product -- Price -- Submission -- Order -- Opportunity -- File -- Message - -The primary purpose of schemas is to control how the flexible entities are represented in the epilot portal UI. +View full [List of Schemas](/docs/entities/schemas-list) page for more info. ## Attributes diff --git a/docs/entities/schemas-list.md b/docs/entities/schemas-list.md new file mode 100644 index 0000000..ac1b94d --- /dev/null +++ b/docs/entities/schemas-list.md @@ -0,0 +1,113 @@ +--- +sidebar_position: 1 +title: Schemas +--- + +import Icon from '@site/src/components/Icon'; + +# List of Schemas + +## Customer Relations + +### Contact + +Contacts store details about customers or individuals managed by the epilot organization. + +### Account + +Accounts store details about companies. Contacts can be linked to an account to represent a business customer. + +### Partner + +Partners store details about collaborating third parties, such as installation partners, OEMs and other business partners. + +### Request + +Requests store customer-initiated service requests or inquiries, usually submitted through contact forms or support channels. + +## Sales + +### Opportunity + +Opportunities store details about sales leads or product inquiries usually made through journeys. + +### Order + +Orders store details about requested products, pricing and past orders placed by customers. + +### Product Hub + +### Product + +Products represent services or products sold by the epilot organization. + +### Price + +Prices configure the pricing models for products. + +### Tax + +Taxes represent the tax rates applied to prices. + +### Coupon + +Coupons represent discounts or promotions that can be applied to products. + + +## Contracts + +### Contract + +Contracts store details about service agreements, tariffs and other agreements between customers and the epilot organization. + +### Billing Event + +Billing events store records of financial transactions, including payments, invoices, and credit notes. + +### Meter + +Meters store details about power, gas or water or other devices used to meter consumption. + +### Meter Counter + +Meter counters represent the counters used in meter devices, allowing separate tracking for different consumption types or purposes, such as peak and off-peak energy usage. + +## Journeys + +### Journey + +Journeys contain the configuration of a customer journey, which is used to collect data from customers. + +### Submission + +Submissions store raw data collected from Journeys or other outside data sources into epilot. + + +## Messaging + +### Message + +Messages are email communications sent and received through the epilot platform. + +### Thread + +Threads represent a conversation that groups multiple email messages together. + +### Email Template + +Email templates are used as templates containing variables for emails sent from epilot. + +## System + +### File + +Files store details about documents, images, templates and other files uploaded to the epilot platform. + +### Comment + +Comments allow users to add notes and have discussions across the platform. + +### Portal User + +Portal users are users registered to use end customer portals or installer portals. + diff --git a/package-lock.json b/package-lock.json index eb7c576..4c5f7c1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,6 +13,7 @@ "@docusaurus/plugin-content-docs": "2.0.0-beta.15", "@docusaurus/preset-classic": "2.0.0-beta.15", "@edno/docusaurus2-graphql-doc-generator": "^1.9.0", + "@epilot360/icons": "^1.16.7", "@graphql-tools/url-loader": "^7.9.1", "@mdx-js/react": "^1.6.21", "@svgr/webpack": "^5.5.0", @@ -2972,6 +2973,15 @@ "node": ">=10.13.0" } }, + "node_modules/@epilot360/icons": { + "version": "1.16.7", + "resolved": "https://registry.npmjs.org/@epilot360/icons/-/icons-1.16.7.tgz", + "integrity": "sha512-WHVTIqR79/kUK8NXDd5iqZFtn6j8z+zeV/C8AlFkPUfn8Eol6NsVcCL2EMbHhYhXWGQgcTW8VAQdCpcMcorXog==", + "license": "MIT", + "peerDependencies": { + "react": ">=17.0.0" + } + }, "node_modules/@eslint/eslintrc": { "version": "0.4.3", "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", diff --git a/package.json b/package.json index 294c93c..9c5de00 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,7 @@ "@docusaurus/plugin-content-docs": "2.0.0-beta.15", "@docusaurus/preset-classic": "2.0.0-beta.15", "@edno/docusaurus2-graphql-doc-generator": "^1.9.0", + "@epilot360/icons": "^1.16.7", "@graphql-tools/url-loader": "^7.9.1", "@mdx-js/react": "^1.6.21", "@svgr/webpack": "^5.5.0", diff --git a/src/components/Icon.tsx b/src/components/Icon.tsx new file mode 100644 index 0000000..e30397f --- /dev/null +++ b/src/components/Icon.tsx @@ -0,0 +1,8 @@ +import { EpilotIcon } from '@epilot360/icons'; +import React from 'react'; + +const Icon = (props: React.ComponentProps) => { + return ; +}; + +export default Icon;