Skip to content

Commit

Permalink
first update to /docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisberno committed Feb 5, 2024
1 parent b960d21 commit db71b8d
Show file tree
Hide file tree
Showing 44 changed files with 26,179 additions and 3,542 deletions.
2 changes: 2 additions & 0 deletions docs/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*/node_modules
*.log
10 changes: 10 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM node:lts

WORKDIR /app/website

EXPOSE 3000 35729
COPY ./docs /app/docs
COPY ./website /app/website
RUN yarn install

CMD ["yarn", "start"]
18 changes: 18 additions & 0 deletions docs/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: "3"

services:
docusaurus:
build: .
ports:
- 3000:3000
- 35729:35729
volumes:
- ./docs:/app/docs
- ./website/blog:/app/website/blog
- ./website/core:/app/website/core
- ./website/i18n:/app/website/i18n
- ./website/pages:/app/website/pages
- ./website/static:/app/website/static
- ./website/sidebars.json:/app/website/sidebars.json
- ./website/siteConfig.js:/app/website/siteConfig.js
working_dir: /app/website
16 changes: 8 additions & 8 deletions docs/docs/00_introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
sidebar_label: Introduction
sidebar_position: 0
slug: /
title: "Flex Project Template"
title: "Connie Realtime Center"
---

<img src="img/logos/flex-text-lightmode.png#gh-light-mode-only" width="275" alt="Twilio Flex" />
<img src="img/logos/flex-text-darkmode.png#gh-dark-mode-only" width="275" alt="Twilio Flex" />
<img src="img/logos/Connie-docs-text-lightmode.png#gh-light-mode-only" width="275" alt="Connie RTC" />
<img src="img/logos/Connie-docs-text-darkmode.png#gh-dark-mode-only" width="275" alt="Connie RTC" />

The _Flex Project Template_ is a starting point for Flex solutions of any size. It provides a methodology for managing all the key assets of a Twilio Flex solution:
The _Connie Realtime Center Template_ is a starting point for all Connie digial communication and digital engagement solutions. It provides a methodology for managing all Connie assets, workflow and integrations. It's also the current home for the Administrators, Supervisors and Agent user manuals.

- It can be used for large projects or simple standalone features
- Many of the most common features requested by Flex customers [are already packaged in the template](/feature-library/overview)
- These documents apply for any installation type.
- Many of the most common features requested by Connie customers [are already packaged in the template](/feature-library/overview)
- Each feature is self-contained and easily removed if desired
- Features can be turned on and off using an [adminstration panel](/feature-library/admin-ui)
- You can [deploy this solution and use it to build in just a few minutes](/getting-started/install-template) by providing your account SID, API key, and API secret.

## Why use this template?

The Twilio platform is a robust suite of tools that can be orchestrated together to create incredible custom solutions. The biggest challenge is how to automatically configure and orchestrate these different tools together from an single source of truth. This is the problem the template aims to resolve.
The Connie platform is a robust suite of tools that can be orchestrated together to create incredible custom solutions. The biggest challenge is how to automatically configure and orchestrate these different tools together from an single source of truth. This is the problem the template aims to resolve.

The template provides a means to manage all of the assets which make up a Flex solution. This aggregates the work _Twilio Professional Services_ have done to show how different features can be robustly implemented on the Flex platform. It can take new Flex developers from 0 to 100 by putting them right in the position of developing feature enhancements instead of worrying about how to manage assets and dependencies on the platform.
The template provides a means to manage all of the assets which make up a digital communication platform solution. This aggregates the work _Connie Professional Services_ have done to show how different features can be robustly implemented on the Connie platform. It can take new Flex developers from 0 to 100 by putting them right in the position of developing feature enhancements instead of worrying about how to manage assets and dependencies on the platform.

Furthermore, with the rich library of examples and conventions, developers can quickly see how to approach different problems on the platform by seeing working code that they can easily reverse engineer.

Expand Down
29 changes: 29 additions & 0 deletions docs/docsX/doc1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
id: doc1
title: Latin-ish
sidebar_label: Example Page
---

Check the [documentation](https://docusaurus.io) for how to use Docusaurus.

## Lorem

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien.

## Mauris In Code

```
Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut.
```

## Nulla

Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra.

## Orci

Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum.

## Phasellus

Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis.
7 changes: 7 additions & 0 deletions docs/docsX/doc2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
id: doc2
title: document number 2
---

This is a link to [another document.](doc3.md)
This is a link to an [external page.](http://www.example.com)
14 changes: 14 additions & 0 deletions docs/docsX/doc3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: doc3
title: This is document number 3
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ac euismod odio, eu consequat dui. Nullam molestie consectetur risus id imperdiet. Proin sodales ornare turpis, non mollis massa ultricies id. Nam at nibh scelerisque, feugiat ante non, dapibus tortor. Vivamus volutpat diam quis tellus elementum bibendum. Praesent semper gravida velit quis aliquam. Etiam in cursus neque. Nam lectus ligula, malesuada et mauris a, bibendum faucibus mi. Phasellus ut interdum felis. Phasellus in odio pulvinar, porttitor urna eget, fringilla lectus. Aliquam sollicitudin est eros. Mauris consectetur quam vitae mauris interdum hendrerit. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Duis et egestas libero, imperdiet faucibus ipsum. Sed posuere eget urna vel feugiat. Vivamus a arcu sagittis, fermentum urna dapibus, congue lectus. Fusce vulputate porttitor nisl, ac cursus elit volutpat vitae. Nullam vitae ipsum egestas, convallis quam non, porta nibh. Morbi gravida erat nec neque bibendum, eu pellentesque velit posuere. Fusce aliquam erat eu massa eleifend tristique.

Sed consequat sollicitudin ipsum eget tempus. Integer a aliquet velit. In justo nibh, pellentesque non suscipit eget, gravida vel lacus. Donec odio ante, malesuada in massa quis, pharetra tristique ligula. Donec eros est, tristique eget finibus quis, semper non nisl. Vivamus et elit nec enim ornare placerat. Sed posuere odio a elit cursus sagittis.

Phasellus feugiat purus eu tortor ultrices finibus. Ut libero nibh, lobortis et libero nec, dapibus posuere eros. Sed sagittis euismod justo at consectetur. Nulla finibus libero placerat, cursus sapien at, eleifend ligula. Vivamus elit nisl, hendrerit ac nibh eu, ultrices tempus dui. Nam tellus neque, commodo non rhoncus eu, gravida in risus. Nullam id iaculis tortor.

Nullam at odio in sem varius tempor sit amet vel lorem. Etiam eu hendrerit nisl. Fusce nibh mauris, vulputate sit amet ex vitae, congue rhoncus nisl. Sed eget tellus purus. Nullam tempus commodo erat ut tristique. Cras accumsan massa sit amet justo consequat eleifend. Integer scelerisque vitae tellus id consectetur.
6 changes: 6 additions & 0 deletions docs/docsX/exampledoc4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: doc4
title: Other Document
---

this is another document
6 changes: 6 additions & 0 deletions docs/docsX/exampledoc5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: doc5
title: Fifth Document
---

Another one
34 changes: 17 additions & 17 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ const { github: lightCodeTheme, dracula: darkCodeTheme } = require("prism-react-

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Flex Project Template",
tagline: "Twilio Professional Services",
favicon: "img/logos/flex.png",
title: "Connie RTC Documents",
tagline: "Connie Professional Services",
favicon: "img/logos/connie-teams.png",

// Set the production url of your site here
url: "https://twilio-professional-services.github.io",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/flex-project-template/",
baseUrl: "/connie-rtc-project-template/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "twilio-professional-services", // Usually your GitHub org/user name.
projectName: "flex-project-template", // Usually your repo name.
organizationName: "connie-professional-services", // Usually your GitHub org/user name.
projectName: "connie-rtc-project-template", // Usually your repo name.
trailingSlash: false,
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
Expand Down Expand Up @@ -78,14 +78,14 @@ const config = {
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Flex Project Template",
title: "Connie RTC Project Template",
logo: {
alt: "Twilio Flex Logo",
src: "img/logos/flex.png",
alt: "Connie RTC Logo",
src: "img/logos/connie-teams.png",
},
items: [
{
href: "https://github.com/twilio-professional-services/flex-project-template",
href: "https://twilio-professional-services.github.io",
label: "GitHub",
position: "right",
},
Expand All @@ -95,15 +95,15 @@ const config = {
style: "dark",
links: [
{
title: "Twilio Docs",
title: "Connie RTC Docs",
items: [
{
label: "Twilio Flex Docs",
href: "https://www.twilio.com/docs/flex",
label: "Connie RTC Developer Docs",
href: "https://twilio-professional-services.github.io",
},
{
label: "Flex Developer Docs",
href: "https://www.twilio.com/docs/flex/developer",
label: "Connie RTC User Docs",
href: "https://twilio-professional-services.github.io",
},
],
},
Expand All @@ -112,12 +112,12 @@ const config = {
items: [
{
label: "GitHub",
href: "https://github.com/twilio-professional-services/flex-project-template",
href: "https://twilio-professional-services.github.io",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Twilio, Inc.`,
copyright: `Copyright © ${new Date().getFullYear()} American Society On Aging, Inc.`,
},
prism: {
theme: lightCodeTheme,
Expand Down
Loading

0 comments on commit db71b8d

Please sign in to comment.