[AI HACKATHON TEST - DO NOT MERGE] Files with NO metadata #432
Closed
dianeba3 wants to merge 3 commits intohackathon-testfrom
Closed
[AI HACKATHON TEST - DO NOT MERGE] Files with NO metadata #432dianeba3 wants to merge 3 commits intohackathon-testfrom
dianeba3 wants to merge 3 commits intohackathon-testfrom
Conversation
Add workflow files for ai metadata generation
| @@ -0,0 +1,127 @@ | |||
| # Lesson 2: Writing a Serverless Action | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Lesson 2: Writing a Serverless Action | |
| --- | |
| title: Lesson 2: Writing a Serverless Action | |
| description: Learn how to write a serverless action to generate Code128 barcodes using the bwip-js library in a serverless environment, and deploy it with Adobe I/O Runtime. | |
| keywords: | |
| - serverless action | |
| - bwip-js barcode | |
| - Adobe I/O Runtime | |
| - Code128 barcode | |
| - App Builder deployment | |
| faqs: | |
| - question: What is bwip-js and why is it used in this lesson? | |
| answer: bwip-js is an npm package for generating barcodes in JavaScript. It is used here because it works well in serverless environments to create Code128 barcodes. | |
| - question: How do you pass data to the barcode generator in the action? | |
| answer: The barcode data is passed through the `value` parameter, which the action uses to generate the barcode image. | |
| - question: How can I run and test the serverless action locally? | |
| answer: You can run the action locally using the CLI command `aio app run --local`, which starts a Docker-based OpenWhisk stack and lets you test the action via a local URL. | |
| - question: What steps are necessary before deploying the action to Adobe I/O Runtime? | |
| answer: Set Adobe I/O Runtime secrets in the `.env` file, disable built-in authentication in `manifest.yml`, and then deploy using `aio app deploy` or `aio app run`. | |
| - question: How do I verify that the generated barcode is correct? | |
| answer: You can verify the barcode by using a barcode reader or scanner app to test the image generated from the action's output. | |
| --- | |
| # Lesson 2: Writing a Serverless Action |
| @@ -0,0 +1,588 @@ | |||
| # Creating your First App Builder Application | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Creating your First App Builder Application | |
| --- | |
| title: Creating your First App Builder Application | |
| description: This tutorial guides you through setting up and developing your first App Builder Application using Adobe Developer Console and CLI tools. Learn how to create projects, configure environments, and deploy your app efficiently. | |
| keywords: | |
| - App Builder Application | |
| - Adobe Developer Console | |
| - Adobe I/O Runtime | |
| - aio CLI | |
| - App Deployment | |
| faqs: | |
| - question: What is the Adobe Developer Console and why is it important? | |
| answer: The Adobe Developer Console is a platform where developers can create projects, access APIs, and manage SDKs necessary for building applications. It is essential for setting up and configuring your App Builder Application environment. | |
| - question: How do I sign in to the CLI to start building my app? | |
| answer: Use the command `aio login` in your terminal. This opens a browser window for Adobe ID authentication. After signing in, a user token is stored in the CLI config, enabling interaction with Adobe Developer Console. | |
| - question: Can I change the App Name after creating the project? | |
| answer: No, the App Name is a unique identifier and cannot be changed once the project setup is complete. | |
| - question: What are workspaces in an App Builder project? | |
| answer: Workspaces serve as development environments within a project, such as Production and Stage, allowing multiple deployment contexts and separate credential configurations for developers. | |
| - question: How do I bootstrap a new App Builder Application using the CLI? | |
| answer: Run the command `aio app init <app_name>`, then follow prompts to select the organization, project, workspace, and extension points to configure and initialize your app project. | |
| --- | |
| # Creating your First App Builder Application |
| @@ -0,0 +1,26 @@ | |||
| # Getting Started with App Builder | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Getting Started with App Builder | |
| --- | |
| title: Getting Started with App Builder | |
| description: This guide provides an introduction to using App Builder and Adobe I/O Runtime, helping you set up your environment and create your first application. Learn essential steps for development, deployment, and troubleshooting. | |
| keywords: | |
| - App Builder | |
| - Adobe I/O Runtime | |
| - Serverless development | |
| - Application deployment | |
| - Development environment setup | |
| faqs: | |
| - question: What is App Builder used for? | |
| answer: App Builder is a tool that simplifies the process of creating and deploying applications using Adobe I/O Runtime. It helps developers build serverless apps efficiently. | |
| - question: How do I start creating my first application with App Builder? | |
| answer: Begin by following the App Builder Getting Started guide, which walks you through environment setup, app creation, publishing, and troubleshooting common issues. | |
| - question: Where can I find more resources after completing the getting started guides? | |
| answer: After completing the initial guides, you can explore the detailed Guides section for advanced features and visit the Resources section for additional support and materials. | |
| --- | |
| # Getting Started with App Builder |
| @@ -0,0 +1,53 @@ | |||
| # Lesson 1: Bootstrap a Headless App | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Lesson 1: Bootstrap a Headless App | |
| --- | |
| title: Lesson 1: Bootstrap a Headless App | |
| description: Learn how to create and configure a simple headless app using the AIO CLI, focusing on setting up an action to test cron jobs and logging execution times. This guide walks through code setup, deployment, and verification steps. | |
| keywords: | |
| - headless app | |
| - AIO CLI | |
| - cron job | |
| - Adobe I/O Runtime | |
| - Node.js action | |
| faqs: | |
| - question: What is a headless app in the context of Adobe I/O? | |
| answer: A headless app is an application without a user interface, designed to run backend logic such as cron jobs or API integrations using Adobe I/O Runtime. | |
| - question: Why should the action not be exposed as a web action? | |
| answer: Not exposing the action as a web action ensures it cannot be accessed by unprivileged users since it is triggered only by internal alarms or cron jobs. | |
| - question: How can I test if my headless app action is working correctly? | |
| answer: After deploying with `aio app deploy`, invoke the action using `aio rt action invoke your-app-name/generic` and check the logs and activation result using `aio rt activation get ID` and `aio rt activation logs ID`. | |
| --- | |
| # Lesson 1: Bootstrap a Headless App |
| @@ -0,0 +1,35 @@ | |||
| # Lesson 3: Types of Alarm Feed | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Lesson 3: Types of Alarm Feed | |
| --- | |
| title: Lesson 3: Types of Alarm Feed | |
| description: This lesson explains the different types of alarm feeds supported by Adobe I/O Runtime, including firing triggers once and on customizable cron schedules. It covers the usage and parameters for each feed type. | |
| keywords: | |
| - Adobe I/O Runtime alarms | |
| - alarm feeds types | |
| - cron trigger scheduling | |
| - once trigger alarms | |
| - whisk.system alarms | |
| faqs: | |
| - question: What is the /whisk.system/alarms/once feed used for? | |
| answer: It is used to fire an event once at a specific date and time, requiring a 'date' parameter to set when the trigger should fire. | |
| - question: How do I schedule an alarm using a cron expression? | |
| answer: You use the /whisk.system/alarms/alarm feed with the 'cron' parameter to specify the schedule in UNIX crontab format. | |
| - question: Can I include a timezone when setting a cron alarm? | |
| answer: Yes, the 'timezone' parameter can be used to define the timezone for the cron trigger schedule. | |
| - question: Are there optional parameters available when using alarm feeds? | |
| answer: Yes, optional parameters include 'trigger_payload' to pass data, and for cron feeds, 'startDate' and 'stopDate' to define active periods. | |
| - question: How do I delete a trigger after it fires once? | |
| answer: Use the 'deleteAfterFire' parameter set to true in the /whisk.system/alarms/once feed inputs to delete the trigger after firing. | |
| --- | |
| # Lesson 3: Types of Alarm Feed |
| @@ -0,0 +1,77 @@ | |||
| # Troubleshooting Common Issues | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Troubleshooting Common Issues | |
| --- | |
| title: Troubleshooting Common Issues | |
| description: A comprehensive guide to resolving frequent problems encountered when developing App Builder applications, including debugging, authentication, and environment setup tips. | |
| keywords: | |
| - App Builder troubleshooting | |
| - debugging App Builder actions | |
| - Adobe I/O Runtime errors | |
| - Node.js M1 chip issues | |
| - App Builder authentication errors | |
| faqs: | |
| - question: How can I check the status of my App Builder action activations? | |
| answer: Use the command `aio runtime activation list` to view recent activations along with status, duration, and ID. You can get detailed results or logs by running `aio runtime activation result activationID` or `aio runtime activation logs activationID`. | |
| - question: What should I do if I encounter a developer error in my action? | |
| answer: Developer errors often stem from compilation issues like missing variables or modules, or action timeouts. Use `aio runtime activation get activationID` to see error details and debug your code accordingly. | |
| - question: How do I handle authentication errors related to Adobe tokens? | |
| answer: Ensure that SPA apps use valid user tokens and headless apps use valid JWT or user access tokens. Remove the `web-src/` folder from headless apps using `aio app delete web-assets` if necessary to avoid token issues. | |
| - question: Why can't I debug actions using State or Files SDK with `aio app dev`? | |
| answer: The State and Files SDKs have extra security restricting access from localhost. You cannot debug locally with these SDKs unless configured to use your own cloud storage, such as Azure Cosmos DB. | |
| - question: How do I resolve Node.js compatibility issues on Mac M1 chips? | |
| answer: Since precompiled Node.js binaries prior to version 15.x don’t support ARM64 on M1, change your shell architecture from arm64 to x86 and use Node Version Manager (nvm) with the recommended macOS troubleshooting steps for M1 chips. | |
| --- | |
| # Troubleshooting Common Issues |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.