Skip to content
Closed
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
45 changes: 45 additions & 0 deletions .github/workflows/ai-deploy-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
###########################
###########################
## Deployment AI generation testing ##
###########################
###########################

name: Hackathon Deployment Request

######################################################
# Start the job on a "deployment" to hackathon-test or other branch #
######################################################

on:
workflow_dispatch:
inputs:
target_branch:
description: "Target branch to send PR to (e.g., main, stage, etc)"
type: string
required: false
default: "hackathon-test"

###############
# Set the Job #
###############

jobs:
ai-metadata-update:
name: AI Metadata Update on Deployment
uses: AdobeDocs/adp-devsite-workflow/.github/workflows/ai-deploy-metadata.yml@app-builder-test
with:
FILE_NAME: "all_pages_content.txt"
secrets:
AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}

lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Lint
run: npx --yes github:AdobeDocs/adp-devsite-utils#add-lint-check runLint -v
40 changes: 40 additions & 0 deletions .github/workflows/ai-pr-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
###########################
###########################
## Pull request testing ##
###########################
###########################
name: Hackathon Pull Request

# Documentation:
# - Workflow: https://help.github.com/en/articles/workflow-syntax-for-github-actions
# - SuperLinter: https://github.com/github/super-linter
# - Markdown linter: https://github.com/DavidAnson/markdownlint
# - Link validation: https://github.com/remarkjs/remark-validate-links

######################################################
# Start the job on a pull request to the hackathon-test branch #
######################################################
on:
pull_request:
branches: [hackathon-test]
paths:
- 'src/pages/**'

###############
# Set the Job #
###############
jobs:
call_reusable_workflow:
name: Generate AI Metadata
# Skip if PR title starts with "[AI PR] Metadata Update" or branch name starts with "ai-metadata"
if: >-
!startsWith(github.event.pull_request.title, '[AI PR] Metadata Update') ||
!startsWith(github.event.pull_request.head.ref, 'ai-metadata')
uses: AdobeDocs/adp-devsite-workflow/.github/workflows/ai-pr-request-metadata.yml@app-builder-test
with:
PR_ID: ${{ github.event.pull_request.number }}
FILE_NAME: "pr_content.txt"
secrets:
AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
Binary file added src/pages/hackathon-some-meta/aep-foundation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions src/pages/hackathon-some-meta/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
---
Comment on lines +1 to +7
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
---
---
title: Developer Community
description: Join the global Developer Community to collaborate, contribute, and build innovative apps and extensions for Adobe Experience Platform and Adobe Experience Cloud.
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- App Builder
faqs:
- question: How can I join the Adobe Developer Community?
answer: You can join by participating in the App Builder Developer Community on Experience League, where you can network, ask questions, and collaborate with other developers.
- question: What contributions can I make to Adobe open-source projects?
answer: Developers can contribute by submitting issues and pull requests to Adobe’s open-source repositories such as the CLI, SDK, App Builder, and I/O Runtime.
- question: What guidelines should I follow when contributing?
answer: Contributors must adhere to Adobe’s Code of Conduct and contribution guidelines to ensure a respectful and productive environment for everyone.
---


# Developer Community

Join the worldwide community of App Builder Developers building apps and extensions for Adobe Experience Platform and Adobe Experience Cloud solutions.

## Get involved

Adobe welcomes contributions from customer, partner, and independent Developers. Here are a few ways to get involved:

* Join the [App Builder Developer Community](https://experienceleaguecommunities.adobe.com/t5/app-builder/ct-p/adobe-app-builder) on Experience League to meet other Developers, exchange information, ask questions, and offer help.
* Contribute issues and pull requests to our open-source repositories, including:
* [CLI repository](https://github.com/adobe/aio-cli)
* [SDK repository]( https://github.com/adobe/aio-sdk)
* [App Builder](https://github.com/AdobeDocs/app-builder) and [I/O Runtime](https://github.com/AdobeDocs/adobe-io-runtime) documentation repositories

Adobe and its contributors agree to a Code of Conduct, and to follow established protocols and best practices to maintain a respectful, productive working environment for all of us. Please review our [contribution guidelines](../guides/contribution-guide.md) for details.
591 changes: 591 additions & 0 deletions src/pages/hackathon-some-meta/first-app.md

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions src/pages/hackathon-some-meta/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Getting Started with App Builder
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Getting Started with App Builder
---
title: Getting Started with App Builder
description: This guide provides an introduction to getting started with App Builder and Adobe I/O Runtime, including setup, creating applications, and troubleshooting. Learn how to develop serverless applications and explore further resources for advanced features.
keywords:
- App Builder guide
- Adobe I/O Runtime
- serverless development
- application publishing
- development environment setup
faqs:
- question: How do I start using App Builder for the first time?
answer: Begin with the App Builder Getting Started guide, which walks you through setting up your development environment, creating your first app, publishing it, and troubleshooting common issues.
- question: What is Adobe I/O Runtime and how does it relate to App Builder?
answer: Adobe I/O Runtime is a serverless platform used by App Builder to deploy and run actions. The Runtime Getting Started guide explains its fundamentals, environment setup, and deployment processes.
- question: Where can I find more advanced information after completing the getting started guides?
answer: After finishing the initial guides, you can explore the detailed Guides section for in-depth features and visit the Resources section for additional support and materials.
---
# Getting Started with App Builder


Welcome to the Getting Started section of App Builder documentation. Here you'll find comprehensive guides to help you start working with App Builder and Adobe I/O Runtime.

## Choose Your Path

### App Builder Getting Started
If you're new to App Builder, start with our [App Builder Getting Started guide](app_builder_get_started/app-builder-intro.md). This guide will walk you through:
- Setting up your development environment
- Creating your first App Builder application
- Publishing your app
- Troubleshooting common issues

### Runtime Getting Started
If you're interested in serverless development with Adobe I/O Runtime, check out our [Runtime Getting Started guide](runtime_getting_started/index.md). This guide covers:
- Understanding Runtime fundamentals
- Setting up your environment
- Creating and deploying actions
- Working with entities and activations
- Best practices and resources

## Next Steps

After completing either getting started guide, you can explore our detailed [Guides](../guides/index.md) section for more in-depth information about specific features and capabilities.

For additional resources and support, visit our [Resources](../resources/index.md) section.
10 changes: 10 additions & 0 deletions src/pages/hackathon-some-meta/more-info/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
contributors:
- 'https://github.com/duynguyen'
title: Codelab Environment Requirements
---
Comment on lines +1 to +5
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
contributors:
- 'https://github.com/duynguyen'
title: Codelab Environment Requirements
---
---
contributors:
- 'https://github.com/duynguyen'
title: Code Lab Environment Setup and Requirements
description: This document outlines the environment requirements and deployment instructions for using the alarms package within the Adobe I/O Runtime environment.
keywords:
- Adobe I/O Runtime
- alarms package
- aio app deploy
- OpenWhisk deployment
- Code Lab environment
faqs:
- question: Why can't I use the alarms package with the local standalone OpenWhisk deployment?
answer: The alarms package is only supported in the Adobe I/O Runtime environment, so it won’t work with local OpenWhisk deployments that use `aio app run --local`.
- question: How do I deploy my app to use the alarms package properly?
answer: You need to deploy or run your app using the commands `aio app run` or `aio app deploy` within the Adobe I/O Runtime environment to ensure the alarms package functions correctly.
---


## Code Lab Environment
## Code Lab Environment

Note that the alarms package described in this lab is available only in the Adobe I/O Runtime environment. In other words, you need to run and deploy your app with either of these commands: `aio app run` or `aio app deploy`. You will not be able to use the package in the local standalone OpenWhisk deployment, which comes with `aio app run --local`.
66 changes: 66 additions & 0 deletions src/pages/hackathon-some-meta/set-up.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Set Up Access, Environment, and Tools
description: App Builder is a complete framework that enables enterprise developers to build and deploy custom web applications that extend Adobe Experience Cloud solutions and run on Adobe infrastructure.
---
Comment on lines +1 to +4
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
title: Set Up Access, Environment, and Tools
description: App Builder is a complete framework that enables enterprise developers to build and deploy custom web applications that extend Adobe Experience Cloud solutions and run on Adobe infrastructure.
---
---
title: Set Up Access, Environment, and Tools
description: App Builder is a complete framework that enables enterprise developers to build and deploy custom web applications that extend Adobe Experience Cloud solutions and run on Adobe infrastructure.
keywords:
- Adobe Experience Cloud
- App Builder setup
- Adobe I/O CLI
- NodeJS environment
- Developer tools
faqs:
- question: What access do I need to start using App Builder?
answer: You need membership in an Adobe Experience Cloud IMS organization with a Developer or System Admin role and a purchased license for App Builder.
- question: Which NodeJS versions are recommended for App Builder development?
answer: NodeJS versions 18 or 20 are recommended, while odd versions are not advised for compatibility reasons.
- question: How do I keep the Adobe I/O CLI up to date?
answer: Check your CLI version with `aio -v` and update it using `npm install -g @adobe/aio-cli` if outdated. Run `aio update` regularly to update plugins.
- question: Is a GitHub account required for App Builder?
answer: A GitHub account is optional but highly recommended for setting up CI/CD workflows and managing your code.
- question: What development environments and terminals are supported?
answer: Windows 10 and 11, and MacOS 10.14+ are supported environments. The Adobe I/O CLI terminals use the inquirer package and work on multiple platforms including Linux Xenial.
---


# Set Up Access, Environment, and Tools

Here you'll learn what systems you need to access, how to access them, and how to configure your local environment.

## Access and credentials

**Adobe Experience Cloud Identity Management Service (IMS) organization** membership, with a Developer or System Admin role, is needed to access App Builder.

* If your organization has a license for App Builder, use the IMS organization where App Builder is provisioned. Some companies have multiple IMS Organizations. Check with your company admin who manages Adobe software for details.

- If you do not have access to your IMS organization:

- Customers should request access from their account manager or their company IT/Marketing admin

- Partners should request App Builder access from their partner manager, or Sandbox access though the [Adobe Solution Partner Portal](https://solutionpartners.adobe.com/home.html)

**App Builder access** is only available with a purchased license.

**[Adobe Developer Console](https://developer.adobe.com/developer-console/)** gives you access to APIs, SDKs, and developer tools. It also provides a way to set up your credentials.

**[A GitHub account](https://github.com/)** is optional but highly recommended for setting up your CI/CD workflow.

## Local environment setup

### Required tools

[**NodeJS**](https://nodejs.org/en/download/), version 18 or 20 (odd versions are not recommended), which will also install the npm package manager. We recommend [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) for NodeJS installation and version management.

[**Adobe I/O Command Line Interface (CLI)**](https://github.com/adobe/aio-cli)

- `npm install -g @adobe/aio-cli`
- If Adobe I/O CLI is already installed, please make sure you have the latest version:
- Check your CLI version using `aio -v` and compare it to`npm show @adobe/aio-cli version`. If your CLI is outdated, update it by running `npm install -g @adobe/aio-cli`.
- Even if your Adobe I/O CLI is up to date, run `aio update` to make sure all core plugins are updated.
- For seven days after release of a new version of Adobe I/O CLI, you'll see a message like this before the command output:

```bash
› Warning: @adobe/aio-cli update available from 3.3.0 to 3.4.1.
› Run npm install -g @adobe/aio-cli to update.
```

#### Supported local environments

We aim to provide similar quality of local development experience on Windows 10 and 11, and MacOS 10.14 and higher.
[Adobe I/O CLI](https://github.com/adobe/aio-cli) and its plugins are automatically tested against NodeJS versions 14 and 16 on both Windows and [Linux Xenial](http://releases.ubuntu.com/16.04/).

#### Supported terminals for the CLI

The [CLI](https://github.com/adobe/aio-cli) uses the popular [inquirer](https://www.npmjs.com/package/inquirer) package for all its interactive functions such as application generators.

See [inquirer's Support section](https://www.npmjs.com/package/inquirer#support-os-terminals) and its [known issues](https://www.npmjs.com/package/inquirer#known-issues) for up-to-date details.

### Optional tool

If you intend to use local development (`aio app dev`) features provided by the [CLI](https://github.com/adobe/aio-cli), you will also need:

- [Visual Studio Code](https://code.visualstudio.com/download), the supported integrated development environment (IDE) for editing, debugging, etc. You may use any other IDE as a code editor, but advanced usage like debugging is not yet supported.

## Next step

Now that you have your environment set up, you can start to [Create your First App Builder Application](first-app.md).