Skip to content

Revert "Revert "My Resources (#286)"" #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/branding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface BrandingConfig {
}

const branding: BrandingConfig = {
title: "SignalWire Developer Portal", // Set to the title of the site. This is added to the window title.
title: "SignalWire Docs", // Set to the title of the site. This is added to the window title.
url: "https://developer.signalwire.com", // Set to the URL of the site.
baseUrl: "/", // Set to the base URL of the site.
favicon: "img/favicon.svg", // set in the 'static/img' folder
Expand Down
4 changes: 1 addition & 3 deletions docs/_common/call-fabric/resource-subscribers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
<div
className="col col--6">

Subscribers represent **registered end-users**,
or internal account-holders,
within the Call Fabric paradigm.
Subscribers are a special type of Resource that represent internal account-holders.

Subscribers always use the `private` [context](/platform/call-fabric#contexts) by default, though `public` Aliases can be added.

Expand Down
2 changes: 1 addition & 1 deletion docs/_common/dashboard/_resource-admonition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
-->

:::info No Resources tab?
If you don't see the **Resources** tab, your SignalWire Space is on the **Legacy Dashboard**.
If you don't see the **My Resources** tab, your SignalWire Space is on the **Legacy Dashboard**.
Refer to the [Legacy](#legacy-dashboard) section of this guide for instructions for your Dashboard and information about the migration.
:::
12 changes: 7 additions & 5 deletions docs/_common/dashboard/_ui-accordion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ Identify your Dashboard and select between Legacy and New UIs using the tabs bel
<div class="row">
<div class="col col--4">
<Frame caption="The redesigned main menu.">
![The main sidebar menu of the new SignalWire Space Dashboard UI.](/images/dashboard/sidebar/new-sidebar.webp)
![The main sidebar menu of the new SignalWire Space Dashboard UI.](/images/dashboard/sidebar/new-sidebar.png)
</Frame>
</div>
<div class="col col--8">
<Frame caption="The new SignalWire Dashboard features a streamlined sidebar menu. Many items are now located in the unified Resource menu.">
![The selection menu when a new Resource is created.](/images/dashboard/resources/add-new-resource.webp)
<Frame caption="The new SignalWire Dashboard features a streamlined sidebar menu. Many items are now located in the unified My Resources menu.">
![The selection menu when a new Resource is created.](/images/dashboard/resources/add-new-resource.png)
</Frame>
</div>
</div>
Resources that were previously accessible in the sidebar of the legacy UI are now located in the **unified Resource menu**.
Resources that were previously accessible in the sidebar of the legacy UI are now located in the unified **My Resources** menu.
</TabItem>

<TabItem value="legacyui" label="Legacy Dashboard">
Expand All @@ -35,9 +35,11 @@ Identify your Dashboard and select between Legacy and New UIs using the tabs bel
</div>

<div className="col col--6">
In the Legacy Dashboard, there is no **Resources** tab.
In the Legacy Dashboard, there is no **My Resources** tab.

Instead, Resources are accessible as individual tabs in the main navigational sidebar.

To upgrade your Space to the New UI, [contact Support](https://support.signalwire.com/).
</div>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_common/dashboard/add-resource-legacy-warning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Refer to the [Legacy](#legacy-dashboard) section of this guide for instructions
:::

<Frame caption="Create and manage all Resources from the SignalWire Dashboard.">
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home-resources-marked.webp)
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home/home-resources-marked.png)
</Frame>

<div className="row">
Expand Down
2 changes: 1 addition & 1 deletion docs/_common/dashboard/add-resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import ResourcesCard from '/docs/_common/call-fabric/resources-fyi-card.mdx';
Find the **Resources** tab in the main sidebar menu of your Dashboard.

<Frame caption="Create and manage all Resources from the SignalWire Dashboard.">
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home-resources-marked.webp)
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home/home-resources-marked.png)
</Frame>

<div className="row">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications/create
title: Create
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# Create a cXML Application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications/delete
title: Delete
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# Delete a cXML Application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications
title: cXML Applications
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# cXML Applications

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications/list
title: List
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# List all cXML Applications

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications/retrieve
title: Retrieve
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# Retrieve a cXML Application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: /compatibility-api/client-sdks/methods/cxml-applications/update
title: Update
---

import LamlAdmonition from "/docs/compatibility-api/_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# Update a cXML Application

Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility-api/cxml/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 0
sidebar_label: Overview
---

import LamlAdmonition from "../_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# The cXML Specification

Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility-api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 0
---

import styles from "./index.module.scss";
import LamlAdmonition from "./_laml-admonition.md"
import LamlAdmonition from "/docs/_common/_laml-admonition.md"

# Introduction to the Compatibility API

Expand Down
2 changes: 1 addition & 1 deletion docs/compatibility-api/sdks/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: /compatibility-api/sdks

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import LamlAdmonition from "../_laml-admonition.md";
import LamlAdmonition from "/docs/_common/_laml-admonition.md";

# Libraries and SDKs

Expand Down
2 changes: 1 addition & 1 deletion docs/home/calling/ai/get-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Once logged in, create a Space or select an existing Space.
</div>

<Frame>
![Resources selection.](@image/dashboard/resources/add-new-resource.webp)
![Resources selection.](@image/dashboard/resources/add-new-resource.png)
</Frame>

### Configure the agent
Expand Down
2 changes: 1 addition & 1 deletion docs/home/calling/video/get-started/pvc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Refer to the [Legacy](#legacy) section of this guide for instructions for your D
:::

<Frame caption="Create and manage all Resources from the SignalWire Dashboard.">
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home-resources-marked.webp)
![The Resources tab of the SignalWire Dashboard.](@image/dashboard/home/home-resources-marked.png)
</Frame>

From within the Resources tab, select **Add New**.
Expand Down
32 changes: 17 additions & 15 deletions docs/home/platform/call-fabric/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import ResourceContexts from '/docs/_common/call-fabric/resource-contexts.md'
import ResourceSubscribers from '/docs/_common/call-fabric/resource-subscribers.md'


## **Overview**
## Overview

SignalWire's Call Fabric represents a transformative evolution from traditional CPaaS, UCaaS,
and CCaaS models, marking a significant shift towards more adaptable and integrated communication solutions.
Traditional CPaaS (Communications Platform as a Service) provides a set of APIs for developers to build
Expand All @@ -24,10 +25,10 @@ focuses on customer service functionalities but frequently operates in isolation

**An Architectural Evolution**

Call Fabric bridges these gaps by offering a holistic, flexible solution that encompasses the strengths of
**Call Fabric** bridges these gaps by offering a holistic, flexible solution that encompasses the strengths of
CPaaS, UCaaS, and CCaaS while eliminating their limitations.
It allows for the creation and management of communication
[resources](#resources) like scripts, rooms, and AI agents with ease,
[Resources](#resources) like scripts, rooms, and AI agents with ease,
providing a fully programmable and scalable platform.
This new apparoach defines a new category of communication services known
as `Programmable Unified Communication` (PUC).
Expand All @@ -51,18 +52,19 @@ requiring minimal developer work, onboarding, or training.

[Resources](/platform/call-fabric/resources) are the primary entities for communication within the Call Fabric ecosystem.
They are the building blocks of the system, representing the various communication tools
that can be used to interact with [subscribers](#subscribers). For example, all of the following are Resources:

- [`Subscribers`](#subscribers)
- [`SWML Scripts`](/swml)
- [`Compatibility XML Webhooks/Applications`](/compatibility-api/cxml)
- [`Relay apps`](/sdks/overview/what-is-relay)
- [`SignalWire AI Agents`](/swml/methods/ai)
- `Video Conferences`:
- [`Programmable API Video Conferences`](/video/getting-started/managing-rooms-with-apis)
- [`Pre-built Video Conferences`](/video/conference)
- [`SIP Endpoints`](/voice/sip/get-started)
- [`FreeSWITCH Connectors`](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Modules/mod_signalwire_19595544/#5-connect-to-signalwire-by-creating-a-new-integrationconnector)
that can be used to interact with [Subscribers](#subscribers).
For example, all of the following are Resources:

- [Subscribers](#subscribers)
- [SWML Scripts](/swml)
- [Compatibility XML Webhooks/Applications](/compatibility-api/cxml)
- [Relay apps](/sdks/overview/what-is-relay)
- [SignalWire AI Agents](/swml/methods/ai)
- Video Conferences:
- [Programmable API Video Conferences](/video/getting-started/managing-rooms-with-apis)
- [Pre-built Video Conferences](/video/conference)
- [SIP Endpoints](/voice/sip/get-started)
- [FreeSWITCH Connectors](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Modules/mod_signalwire_19595544/#5-connect-to-signalwire-by-creating-a-new-integrationconnector)


#### Resource Addresses
Expand Down
11 changes: 7 additions & 4 deletions docs/home/platform/call-fabric/resources/ai-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ slug: /platform/call-fabric/resources/ai-agents

## About

Use this section of the Dashboard to create, configure, and manage AI Agents.
For more information on AI Agents, please refer to the
[AI Agent Documentation](/ai/get-started/).
Use this section of the Dashboard to create, configure, and manage AI Agent Resources.

<Frame caption="AI Agents in the Dashboard">
![The AI Agents tab in the Dashboard.](@image/dashboard/resources/ai-agent/new-agent.webp)
</Frame>
</Frame>

## Learn more

For more information on AI Agents, please refer to the
[AI Agent Documentation](/ai/get-started/).
10 changes: 9 additions & 1 deletion docs/home/platform/call-fabric/resources/cxml-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,23 @@ description: Learn about the Subscriber Resource on the SignalWire platform - wh
slug: /platform/call-fabric/resources/cxml-scripts
---

# cXML Scripts (LaML Webhook/Application) {#cxml-script}
# cXML Scripts

<Subtitle>Resources on the Call Fabric platform</Subtitle>

## About

The cXML (Compatibility XML) Script Resource type is used to create and manage LaML Webhook/Applications.

:::note LAML Webhooks and Applications
cXML Scripts were formerly known as LaML Webhooks and LaML Applications.
:::

## Details

A cXML Script Resource has a single text box where the cXML should be input.

## Learn more

For more information on Compatibility XML, please refer to the
[cXML API Documentation](/compatibility-api/cxml).
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ slug: /platform/call-fabric/resources/dialogflow-agents
The Dialogflow Agent Resource type is used to create and manage Google Dialogflow Agents.
Create a Dialogflow Agent by first selecting AI Agent from the Resources menu.

## Learn more

For more information on Dialogflow Agents, please refer to the
[Dialogflow Agent Documentation](/platform/integrations/dialogflow/dialogflow-agents/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ slug: /platform/call-fabric/resources/freeswitch-connectors

The FreeSWITCH Connector Resource type is used to create and manage FreeSWITCH Connectors.

## Details

A FreeSWITCH Connector Resource will have the following details:

| Detail | Value |
|:-------|:---------------------------------------|
| Name | The name of the FreeSWITCH Connector. |
| Token | The token of the FreeSWITCH Connector. |

## Learn more

For more information on FreeSWITCH Connectors, please refer to the
[FreeSWITCH Connector Documentation](/platform/integrations/freeswitch/installing-freeswitch-or-freeswitch-advantage).
16 changes: 10 additions & 6 deletions docs/home/platform/call-fabric/resources/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ that can be used to interact with
<div className="row">

<div className="col col--6">
To create a Resource in your SignalWire Space, click on the `Resources` tab in the left-hand navigation menu.
To create a Resource in your SignalWire Space, click on the **My Resources** tab in the left-hand navigation menu.

From there, you can select the type of Resource you would like to create by clicking on the <kbd>+ Add</kbd> button.
</div>
Expand All @@ -67,18 +67,22 @@ that can be used to interact with

caption="Create a new Resource from the Dashboard">

![Create a new Resource from the Dashboard](@image/dashboard/home-resources-marked.webp)
![Create a new Resource from the Dashboard](@image/dashboard/home/home-resources-marked.png)

</Frame>

After selecting a Resource,
enter the details for the Resource on a new page,
and select <kbd>Create</kbd> to confirm.
Click the **Add** button to select from the grid of available Resource types.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.webp)
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>

Alternatively, you can create new Resources from their subpages in the sidebar menu, or using the shortcuts on the Dashboard homepage.

After selecting a Resource,
enter the details for the Resource on a new page,
and select <kbd>Create</kbd> to confirm.

### Modify or delete

From the Resources page in your SignalWire Dashboard, select the desired Resource to open a detailed view.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ slug: /platform/call-fabric/resources/relay-applications

## About

Relay Applications are powerful applications running on your own server or a client such as a browser or mobile application,
built with one of the [Server or Client Relay SDKs](/sdks/).
Use a Relay Application Resource to connect your Relay Application to SignalWire via a secure realtime websocket connection.

## Details

A Relay Application Resource will have the following details:

| Detail | Value |
Expand All @@ -21,5 +27,7 @@ A Relay Application Resource will have the following details:
![Details of a Relay App on the SignalWire Dashboard.](@image/dashboard/resources/relay-app.webp)
</Frame>

## Learn more

For more information on Relay, please refer to the
[Relay documentation](/sdks/overview/what-is-relay).
2 changes: 2 additions & 0 deletions docs/home/platform/call-fabric/resources/sip-gateways.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ and [SIP Endpoints](/voice/sip/get-started), which are for registering your devi
![Creating a SIP Gateway Resource in the SignalWire Dashboard.](@image/dashboard/resources/sip/sip-gateway.png)
</Frame>

## Details

<SipGatewayParams/>
4 changes: 4 additions & 0 deletions docs/home/platform/call-fabric/resources/subscribers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ import ResourceSubscribers from '/docs/_common/call-fabric/resource-subscribers.

<Subtitle>Resources on the Call Fabric platform</Subtitle><br/><br/>

## About

<ResourceSubscribers />

## Details

A subscriber Resource will have the following details:

| Detail | Value |
Expand Down
Loading