Skip to content

Commit

Permalink
docs: distribution docs 2.0 (#339)
Browse files Browse the repository at this point in the history
* docs: re-organization distribution docs, add required products info

* docs: remove og packaging guide

* add valid products list
  • Loading branch information
MichaelGoberling authored Jun 28, 2024
1 parent 761c00c commit 69e722a
Show file tree
Hide file tree
Showing 11 changed files with 400 additions and 51 deletions.
18 changes: 14 additions & 4 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,6 @@ module.exports = {
{
"title": "Event hooks for App Builder Applications",
"path": "guides/app-hooks.md"
},
{
"title": "Packaging for Developer Distribution",
"path": "guides/packaging.md"
}
]
},
Expand Down Expand Up @@ -203,6 +199,20 @@ module.exports = {
}
]
},
{
"title": "Distribution",
"path": "guides/distribution/index.md",
"pages": [
{
"title": "Private Distribution",
"path": "guides/distribution/private.md"
},
{
"title": "Public Distribution",
"path": "guides/distribution/public.md"
}
]
},
{
"title": "Integration Guide with Adobe Experience Cloud",
"path": "guides/exc_app",
Expand Down
7 changes: 7 additions & 0 deletions src/pages/guides/app-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ hooks:
test: echo this is your custom test runner
```

`aio app pack` supports:
```yaml
hooks:
pre-pack: echo this is before packaging
post-pack: echo this is after packaging
```

## Use cases

`aio app run` hooks:
Expand Down
36 changes: 36 additions & 0 deletions src/pages/guides/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,22 @@ extensions:
function: actions/worker/index.js
web: 'yes'
runtime: nodejs:18

# public distribution only - customer configuration
configSchema:
title: 'the title'
description: 'the description'
properties:
- title: 'Slack Webhook'
type: 'string'
description: 'Please provide the webhook used by this application. Configure in slack.com'
envKey: 'SLACK_WEBHOOK'

# public distribution only - required products
requiredProducts:
- code: AEP
minVersion: 0.0.0
maxVersion: 1.0.0
```
### Standalone application and extensions
Expand Down Expand Up @@ -280,6 +296,26 @@ extensions:

Configuration paths defined in `./src/dx-excshell-1/ext.config.yaml` must be relative to that file.

### Public distribution configuration

A subset of configuration options are specific to publicly distributable apps. See the [Public Distribution](../distribution/public.md) guide for more details.

```yaml
configSchema:
title: 'the title'
description: 'the description'
properties:
- title: 'Slack Webhook'
type: 'string'
description: 'Please provide the webhook used by this application. Configure in slack.com'
envKey: 'SLACK_WEBHOOK'
requiredProducts:
- code: AEP
minVersion: 0.0.0
maxVersion: 1.0.0
```

## `.env`

The `.env` file is used to store:
Expand Down
22 changes: 22 additions & 0 deletions src/pages/guides/distribution/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
keywords:
- Distribution
- Local Distribution
- App Builder
- Public
- Private
title: Distribution
description: The Developer Console and aio CLI provide features for developers to distribute their App Builder applications. This documentation focuses on the distribution step of this lifecycle.
---

# Distribution Overview

Developers can distribute their App Builder apps privately or publicly.

## Private

Privately distributed apps are only available to members of the developer's organization. See [Private Distribution](./private.md) for more details.

## Public

Publicly distributed apps are available for install via Adobe Exchange. See [Public Distribution](./public.md) for details on how to configure and prepare your app for public distribution.
20 changes: 20 additions & 0 deletions src/pages/guides/distribution/private.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
keywords:
- Distribution
- Local Distribution
- App Builder
- Private
title: Private Distribution
description: This documentation focuses on privately distributing App Builder applications.
---

# Private Distribution
Distribute apps to other members in your Adobe organization.

## Overview

Privately distributed apps are only available to users in the developer's organization and can be accessed via the [App Builder Catalog](https://experience.adobe.com/#/@adobeio/custom-apps). These apps are submitted via the [Developer Console](https://developer.adobe.com/console) and reviewed by admins of the developer's organization.

See [Publishing Your First App Builder Application](../../getting_started/publish_app.md) for a thorough walkthrough on this topic.

> Note: In order for your app to show up in the App Builder Catalog, it must be an Experience Cloud Shell extension.
Loading

0 comments on commit 69e722a

Please sign in to comment.