diff --git a/docs/360-portal/_category_.json b/docs/360-portal/_category_.json index 021d142..ec2e9da 100644 --- a/docs/360-portal/_category_.json +++ b/docs/360-portal/_category_.json @@ -1,4 +1,4 @@ { - "label": "360 Portal", + "label": "epilot portal", "position": 4 } diff --git a/docs/360-portal/libs/auth-service.md b/docs/360-portal/libs/auth-service.md index 2505940..ecf23d9 100644 --- a/docs/360-portal/libs/auth-service.md +++ b/docs/360-portal/libs/auth-service.md @@ -8,7 +8,7 @@ sidebar_position: 2 yarn add @epilot360/auth-service ``` -Access current user's auth information in epilot 360 portal. +Access current user's auth information in epilot portal. ## Usage diff --git a/docs/360-portal/libs/feature-flags-service.md b/docs/360-portal/libs/feature-flags-service.md index 85af37e..4d9e36e 100644 --- a/docs/360-portal/libs/feature-flags-service.md +++ b/docs/360-portal/libs/feature-flags-service.md @@ -8,7 +8,7 @@ sidebar_position: 3 yarn add @epilot360/feature-flag-service ``` -Use feature flags in epilot 360 portal. +Use feature flags in epilot portal. ## Usage diff --git a/docs/360-portal/libs/i18n.md b/docs/360-portal/libs/i18n.md index 47dd5cc..a2ea7df 100644 --- a/docs/360-portal/libs/i18n.md +++ b/docs/360-portal/libs/i18n.md @@ -8,7 +8,7 @@ sidebar_position: 1 yarn add @epilot360/i18n ``` -Translation and localisation library for the epilot360 portal. +Translation and localisation library for the epilotepilot portal. Uses [i18next](https://www.i18next.com/). @@ -30,8 +30,8 @@ Translations are loaded asynchronously, so make sure to wrap your app inside ` ## Creating Access Tokens -Users logged into the epilot 360 portal can manage their Access Tokens from [Settings > Access Tokens](https://portal.epilot.cloud/app/tokens). +Users logged into the epilot portal can manage their Access Tokens from [Settings > Access Tokens](https://portal.epilot.cloud/app/tokens). Creating access tokens requires the `token:create` permission. diff --git a/docs/datalake/epilot-datalake.mdx b/docs/datalake/epilot-datalake.mdx index dc37bcd..c18e3b1 100644 --- a/docs/datalake/epilot-datalake.mdx +++ b/docs/datalake/epilot-datalake.mdx @@ -4,7 +4,7 @@ sidebar_position: 1 # Epilot Datalake -Welcome to the documentation for our Data Lake feature, which serves as the centralized repository for real-time event streams of entity operations, snapshots of workflow executions and journey analytics data. This feature empowers users to access and analyze essential data generated by the 360 portal, including changes to entities such as orders, opportunities, contacts, accounts, products, interactions from user journeys and more. +Welcome to the documentation for our Data Lake feature, which serves as the centralized repository for real-time event streams of entity operations, snapshots of workflow executions and journey analytics data. This feature empowers users to access and analyze essential data generated by the epilot portal, including changes to entities such as orders, opportunities, contacts, accounts, products, interactions from user journeys and more. Our Data Lake is seamlessly integrated with Clickhouse for data warehousing, enabling the users to leverage Business Intelligence (BI) tools and create insightful reports. This documentation will guide you through the key components of the Data Lake feature, including data schemas, usage, and credential management. @@ -266,4 +266,4 @@ Our Journey Analytics Data lake feature offers a comprehensive solution to track You can also refer to the following link to establish connection to [different BI tools.](https://clickhouse.com/docs/en/integrations/data-visualization) -If you have any further questions or need assistance with data queries, please reach out to our team. \ No newline at end of file +If you have any further questions or need assistance with data queries, please reach out to our team. diff --git a/docs/entities/flexible-entities.md b/docs/entities/flexible-entities.md index 3fbd851..8fdc3ec 100644 --- a/docs/entities/flexible-entities.md +++ b/docs/entities/flexible-entities.md @@ -31,7 +31,7 @@ Examples of Entity Schemas: - File - Message -The primary purpose of schemas is to control how the flexible entities are represented in the epilot 360 portal UI. +The primary purpose of schemas is to control how the flexible entities are represented in the epilot portal UI. ## Attributes diff --git a/docs/intro.md b/docs/intro.md index 5705cd9..e469696 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -10,7 +10,7 @@ sidebar_position: 1

Documentation

-

Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot 360 platform.

+

Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.

## Architecture diff --git a/docs/journeys/journey-builder.md b/docs/journeys/journey-builder.md index 414e312..45e69d1 100644 --- a/docs/journeys/journey-builder.md +++ b/docs/journeys/journey-builder.md @@ -14,7 +14,7 @@ The Journey Builder is a WYSIWYG editor interface that allows you to build and e ## Embedding Journeys -Journeys can be shared within the epilot 360 portal to other users or embedded to 3rd party websites using a script snippet. +Journeys can be shared within the epilot portal to other users or embedded to 3rd party websites using a script snippet. Script snippets for embedding can be generated directly from the Journey Builder: diff --git a/docs/portals/portal-webhooks.md b/docs/portals/portal-webhooks.md index 047487d..ff4065d 100644 --- a/docs/portals/portal-webhooks.md +++ b/docs/portals/portal-webhooks.md @@ -7,7 +7,7 @@ sidebar_position: 3 Customer and installer portals specific webbhooks allow to integrate applications with the activities emitted within portal. -In the Epilot 360 portal you can configure a webhook which includes the activity: +In the epilot portal you can configure a webhook which includes the activity: ![Doc Downloaded Webhook](../../static/img/portals/doc-downloaded-webhook.png) @@ -66,4 +66,4 @@ Example of the webhook message for the activity "DocDownloadedFromPortal": ``` ## Activity Types -- `DocDownloadedFromPortal` - Automation trigger "File Activity: File Downloaded from portal" \ No newline at end of file +- `DocDownloadedFromPortal` - Automation trigger "File Activity: File Downloaded from portal" diff --git a/docs/pricing/2-catalog.mdx b/docs/pricing/2-catalog.mdx index 1ec668a..c51064d 100644 --- a/docs/pricing/2-catalog.mdx +++ b/docs/pricing/2-catalog.mdx @@ -3,7 +3,7 @@ sidebar_position: 2 title: Catalog --- -One of our core features within the epilot 360 platform is the ability to create and manage a catalog of all your products, prices and tax rates. This catalog is the foundation of your entire business and is the starting point for all your other epilot 360 features. +One of our core features within the epilot platform is the ability to create and manage a catalog of all your products, prices and tax rates. This catalog is the foundation of your entire business and is the starting point for all your other epilot features. - - + + @@ -19,7 +19,7 @@ title: Pricing Pricing is one of the core topics built directly into the epilot ecosystem of applications and services. It comprises multiple concepts such as products, prices, taxes, orders, payments and more. -Within our 360 Portal we have built a nice set of UIs to help our customers model their products, prices and taxes. These interfaces are built to deliver a 1st class solution with the aim of enabling our users to search, filter and export/import their data freely. Due to this purpose, our interfaces are fully extendable and customizable. Which means that, all the attributes and features we provide are merely the start of many possible journeys. +Within our epilot portal we have built a nice set of UIs to help our customers model their products, prices and taxes. These interfaces are built to deliver a 1st class solution with the aim of enabling our users to search, filter and export/import their data freely. Due to this purpose, our interfaces are fully extendable and customizable. Which means that, all the attributes and features we provide are merely the start of many possible journeys. All our pricing entities are fully extendable, therefore, on top of our opinionated set of attributes and features you can easy craft and add your own. And if you feel limited in any way, through webhooks you can easily extend the functionality of our pricing entities and build your own custom pricing logic over your corporate backends. diff --git a/docs/pricing/pricing-library/README.md b/docs/pricing/pricing-library/README.md index d77b5ca..2067131 100644 --- a/docs/pricing/pricing-library/README.md +++ b/docs/pricing/pricing-library/README.md @@ -2,7 +2,7 @@ # Pricing Library -A library that provides pricing utility operations for Pricing Entities within the epilot 360 Platform, such as calculation of price item totals and aggregated totals. The purpose of this library is to provide support for common pricing concerns to all our APIs, micro-frontends and epilot Journeys. +A library that provides pricing utility operations for Pricing Entities within the epilot Platform, such as calculation of price item totals and aggregated totals. The purpose of this library is to provide support for common pricing concerns to all our APIs, micro-frontends and epilot Journeys. ## Getting Started diff --git a/docs/sso/single-sign-on.mdx b/docs/sso/single-sign-on.mdx index 5da835e..8ec2a78 100644 --- a/docs/sso/single-sign-on.mdx +++ b/docs/sso/single-sign-on.mdx @@ -4,9 +4,9 @@ sidebar_position: 1 # Single Sign On -In today's digital age, managing multiple usernames and passwords for various applications can be cumbersome. To enhance your experience and security, Epilot 360 is equipped with a Single Sign-On (SSO) feature. SSO simplifies this process by allowing you to access multiple services with a single set of credentials. This means less time spent managing accounts and more time focusing on what's important - your work. +In today's digital age, managing multiple usernames and passwords for various applications can be cumbersome. To enhance your experience and security, epilot is equipped with a Single Sign-On (SSO) feature. SSO simplifies this process by allowing you to access multiple services with a single set of credentials. This means less time spent managing accounts and more time focusing on what's important - your work. -## Steps to configure SSO in Epilot 360 +## Steps to configure SSO in epilot We support OIDC authentication right now with our SSO configurations. @@ -31,7 +31,7 @@ Now, fill in the details in the SSO configuration form as specified in the pictu Now, you can configure the role mappings for the authenticated user based on the claims from the token payload. You can also choose the default role, which will be assigned to the user if none of the role mappings match. -When Dynamic Role Mapping is enabled, user roles are synchronized with the 360 Portal each time the user logs in via SSO. If disabled, roles are only mapped during the user's initial SSO login to the 360 Portal. +When Dynamic Role Mapping is enabled, user roles are synchronized with the epilot portal each time the user logs in via SSO. If disabled, roles are only mapped during the user's initial SSO login to the epilot portal. ![SSO role mappings](/img/sso/sso-role-mapping.png) @@ -46,4 +46,4 @@ Once the app registration is complete, create a new secret and fill in the detai ![SSO OIDC](/img/sso/sso-oidc.png) -Now click on save. You can directly login using the SSO, by copying the url from the saved configuration. If you have any further questions or need assistance with setting up SSO, please reach out to our team. \ No newline at end of file +Now click on save. You can directly login using the SSO, by copying the url from the saved configuration. If you have any further questions or need assistance with setting up SSO, please reach out to our team. diff --git a/docs/webhooks.md b/docs/webhooks.md index 8f28d52..6211555 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -42,7 +42,7 @@ Already known services which do not support chunked transfer encoding are: ## Webhook Payload Structure -You can use the Entity API to get a full [JSON schema](/api/entity#tag/Schemas/operation/getJsonSchema) and a [JSON example](/api/entity#tag/Schemas/operation/getSchemaExample) of an entity part of your webhook. Alternatively, you can download these from the 360 Portal for each of your entities from the entity builder UI. +You can use the Entity API to get a full [JSON schema](/api/entity#tag/Schemas/operation/getJsonSchema) and a [JSON example](/api/entity#tag/Schemas/operation/getSchemaExample) of an entity part of your webhook. Alternatively, you can download these from the epilot portal for each of your entities from the entity builder UI. ![Export Entity Schema](../static/img/export-entity-schema.png) @@ -158,4 +158,4 @@ Custom OAuth parameters can be seamlessly integrated into the webhook configurat ## Limitations ### Timeout -As previously mentioned, the webhook request times out after 30 seconds for synchronous webhooks. For asynchronous webhooks, the request will not time out, but the webhook will be flagged as unsuccessful if the request takes longer than 2 minutes to complete. This is to prevent the webhook from being stuck in a pending state indefinitely. Contact support if you need to increase this timeout. Keep in mind that for long running requests, it is recommend to handle them asynchronously on the 3rd party side and return a 202 Accepted response to the webhook request. \ No newline at end of file +As previously mentioned, the webhook request times out after 30 seconds for synchronous webhooks. For asynchronous webhooks, the request will not time out, but the webhook will be flagged as unsuccessful if the request takes longer than 2 minutes to complete. This is to prevent the webhook from being stuck in a pending state indefinitely. Contact support if you need to increase this timeout. Keep in mind that for long running requests, it is recommend to handle them asynchronously on the 3rd party side and return a 202 Accepted response to the webhook request. diff --git a/docusaurus.config.js b/docusaurus.config.js index efc05d3..a6630a8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -126,7 +126,7 @@ const DOCS_URL = 'https://docs.epilot.io'; title: 'Links', items: [ { - label: '360 Portal', + label: 'epilot portal', href: 'https://portal.epilot.cloud', }, {