Skip to content

Commit

Permalink
docs(apps): push first iteration of apps without exposing it to the n…
Browse files Browse the repository at this point in the history
…avigation
  • Loading branch information
Sebastian Sauerer committed Feb 26, 2025
1 parent 13b8d58 commit ebb7fba
Show file tree
Hide file tree
Showing 21 changed files with 429 additions and 10 deletions.
8 changes: 8 additions & 0 deletions apps/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Apps",
"position": 2,
"collapsed": false,
"link": {
"type": "generated-index"
}
}
5 changes: 5 additions & 0 deletions apps/architecture/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Architecture",
"position": 3,
"collapsed": true
}
23 changes: 23 additions & 0 deletions apps/architecture/app-lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: App Lifecycle
hide_title: true
sidebar_position: 2
description: Understand when and how Apps are executed
---

<p>&nbsp;</p>


<h1 align="center">App Lifecycle</h1>

<p align="center">How Apps are executed</p>

## Use Case

## Links

## Hooks


https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

18 changes: 18 additions & 0 deletions apps/architecture/behind-the-scenes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Behind The Scenes
hide_title: true
sidebar_position: 1
description: Learn how Apps are designed and built on the epilot platform.
---

<p>&nbsp;</p>


<h1 align="center">Behind The Scenes: How Apps are designed</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

17 changes: 17 additions & 0 deletions apps/architecture/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Security
hide_title: true
sidebar_position: 3
description: Dive into security considerations for epilot Apps.
---

<p>&nbsp;</p>

<h1 align="center">Seurity</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

5 changes: 5 additions & 0 deletions apps/components/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Components",
"position": 4,
"collapsed": true
}
17 changes: 17 additions & 0 deletions apps/components/custom-journey-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Custom Journey Block
hide_title: true
sidebar_position: 2
---

<p>&nbsp;</p>


<h1 align="center">Custom Journey Blocks</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

22 changes: 22 additions & 0 deletions apps/components/portal-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Portal Extensions
hide_title: true
sidebar_position: 2
---

<p>&nbsp;</p>


<h1 align="center">Portal Extensions</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

## Links

## Hooks


https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

5 changes: 5 additions & 0 deletions apps/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Getting Started",
"position": 2,
"collapsed": true
}
40 changes: 40 additions & 0 deletions apps/getting-started/developer-sandbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Developer Sandbox
hide_title: true
sidebar_position: 2
---

<p>&nbsp;</p>


<h1 align="center">Developer Sandbox</h1>

<p align="center">Request a developer sandbox account and start building your first App</p>

## Request a developer sandbox account and start building your first App

The typical epilot portal is designed for production-ready use cases, where even small configuration errors could affect running systems. These errors might potentially result in data loss and diminished trust from end customers.

This is why epilot offers dedicated sandbox accounts. These environments are specifically created to allow developers to experiment with the platform in a safe space. A sandbox provides a limited but functional environment where you can configure and test various features without any risk to production systems.

### Your Path to App Development

Sandbox accounts serve as the perfect starting point for creating your first app in the epilot ecosystem. The general workflow is straightforward:

1. Request a sandbox account by submitting a request here:
2. Once your request has been reviewed and approved, sign up with the credentials provided
3. Navigate to the app creation page at https://portal.epilot.cloud/app/apps/configuration/new to begin building your first private app

### The Value of a Sandbox Environment

You might wonder why a separate account is necessary for development. A sandbox account provides several key benefits:

It creates an isolated version of your app where you can freely experiment. This isolation ensures that your development activities won't affect other users or systems within the epilot ecosystem. Think of it as your personal laboratory where experiments can safely take place.

The sandbox serves as a comprehensive playground where you can configure the app according to your specific needs and conduct thorough testing. You can push boundaries, try different approaches, and even make mistakes—all without consequences to production environments.

Initially, your app will only be available for installation within your own sandbox account. This limitation is actually beneficial during the development phase as it prevents premature exposure of your work.

Once you feel confident about your app's functionality and stability, you can request a formal review of a specific version. This review process is the gateway to making your app publicly available to the wider epilot community.

To learn more about the review process and how to submit your app for review, refer to the [Publishing](/apps/publishing/how-to) section.
33 changes: 33 additions & 0 deletions apps/getting-started/private-vs-public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Private vs Public
hide_title: true
sidebar_position: 3
---

<p>&nbsp;</p>

<p align="center"><a href="/"><img src="/img/logo.png" width="150" /></a></p>

<h1 align="center">Technically</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Architecture


## Components

### Components
Explore and learn to use our APIs to build your own solutions on epilot.

[Overview](/docs/architecture/api-first) - [Docs](/api)

## SDK

Explore our developer tools and get started with the epilot SDK

[Overview](/docs/architecture/sdk)

## Contact us

You can always [open an issue](https://github.com/epilot-dev/docs/issues) on our GitHub repository, or if you're already a customer, contact us via customer support to receive technical assistance.
33 changes: 33 additions & 0 deletions apps/getting-started/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Quickstart
hide_title: true
sidebar_position: 2
---

<p>&nbsp;</p>

<p align="center"><a href="/"><img src="/img/logo.png" width="150" /></a></p>

<h1 align="center">Technically</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Architecture


## Components

### Components
Explore and learn to use our APIs to build your own solutions on epilot.

[Overview](/docs/architecture/api-first) - [Docs](/api)

## SDK

Explore our developer tools and get started with the epilot SDK

[Overview](/docs/architecture/sdk)

## Contact us

You can always [open an issue](https://github.com/epilot-dev/docs/issues) on our GitHub repository, or if you're already a customer, contact us via customer support to receive technical assistance.
18 changes: 18 additions & 0 deletions apps/introduction/ key-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Key Features
hide_title: true
sidebar_position: 2
description: Learn about the core concepts and features of epilot apps.
---

<p>&nbsp;</p>


<h1 align="center">Custom Journey Blocks</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

5 changes: 5 additions & 0 deletions apps/introduction/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Introduction",
"position": 1,
"collapsed": true
}
82 changes: 82 additions & 0 deletions apps/introduction/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Overview
hide_title: true
sidebar_position: 1
description: "Welcome to the epilot Developer Platform documentation!"
---

<p>&nbsp;</p>

<p align="center"><a href="/"><img src="/img/logo.png" width="150" /></a></p>

<h1 align="center">Building Apps</h1>

<p align="center">Welcome to the epilot Developer Platform documentation! Whether you are a new or experienced app builder, this is your go-to resource for learning how to create and manage powerful app integrations for the epilot platform</p>



## What You’ll Find Here
<div className="row margin-bottom--lg">
<div className="col">
<div className="card">
<div className="card__body">
<h3>🚀 Quick Start Guides</h3>
<p>Get up and running with step-by-step tutorials and sample applications that demonstrate core concepts and best practices.</p>
</div>
</div>
</div>
<div className="col">
<div className="card">
<div className="card__body">
<h3>🛠️ Technical References</h3>
<p>Detailed API documentation, component specifications, and integration guides to help you build with confidence.</p>
</div>
</div>
</div>
</div>
<div className="row">
<div className="col">
<div className="card">
<div className="card__body">
<h3>📚 Use Cases</h3>
<p>Real-world examples and implementation patterns for common business scenarios and integration challenges.</p>
</div>
</div>
</div>
<div className="col">
<div className="card">
<div className="card__body">
<h3>🎯 Best Practices</h3>
<p>Guidelines and recommendations for building secure, scalable, and maintainable applications on epilot.</p>
</div>
</div>
</div>
</div>

## Why should you build on epilot?
### Seamless Integration
Build apps that naturally extend epilot's capabilities through our modern API-first architecture. Whether you're creating custom journey blocks or portal extensions, your apps become native parts of the epilot experience.

### Developer-First Platform
We've designed our platform with developers in mind:

### Streamlined app publishing workflow with automated validation
Comprehensive development tools and SDKs
Flexible component system for building custom UI elements
Built-in support for internationalization

### Enterprise-Ready Infrastructure
Your apps run on the same robust infrastructure that powers epilot:

- Secure authentication and authorization
- Scalable cloud infrastructure
- Real-time updates and notifications
- Comprehensive monitoring and logging

### Growing Ecosystem
Join a thriving community of developers building the future of energy and utility solutions:

### Access to a marketplace of energy industry customers
- Share and monetize your innovations
- Collaborate with industry experts
- Regular platform updates and new capabilitie
5 changes: 5 additions & 0 deletions apps/publishing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Publishing",
"position": 5,
"collapsed": true
}
17 changes: 17 additions & 0 deletions apps/publishing/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Quick Start
hide_title: true
sidebar_position: 1
---

<p>&nbsp;</p>


<h1 align="center">Custom Journey Blocks</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

17 changes: 17 additions & 0 deletions apps/publishing/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Publishing Requirements
hide_title: true
sidebar_position: 3
---

<p>&nbsp;</p>


<h1 align="center">Custom Journey Blocks</h1>

<p align="center">Learn the basics of using epilot developer tools and APIs to unlock the potential of the epilot platform.</p>

## Use Case

https://github.com/epilot-dev/epilot-journey-sdk/blob/main/custom-block.md

Loading

0 comments on commit ebb7fba

Please sign in to comment.