One short paragraph: what this example shows and who it is for. If it maps to a Workday use case (a card on the home page, an approval flow, a report), say so here.
Bullet the contents of this folder so a reader knows what they are looking at. For instance:
app/holds the exported Extend app sourceorchestrations/holds the orchestration definitionsSKILL.mdis the agent skilldiagrams/holds the architecture drawings
The concrete steps to put this example to work, whatever that means for this artifact. Examples:
- Extend app source: deploy to your WCP development tenant with your usual tooling (App Builder, the IDE plugins, or the WDCLI), then install and launch.
- Orchestration: import it in Orchestration Builder, promote if your tenant needs it, and deploy to your tenant.
- Agent skill or reference material: read it, copy it, adapt it.
If your example needs configuration (credentials, tenant URLs), document the variables here and never commit real values.
Metadata is JSON only. All fields:
| Field | Required | What to put there |
|---|---|---|
title |
Yes | Short display name, shown on the card |
description |
Yes | One or two sentences, shown on the card and in the README index |
type |
Yes | What this example is. One of the types in hub.config.json, for example Extend App, Orchestration, Agent Skill |
components |
No | Building blocks used, from the components list in hub.config.json (Presentation, Model, Orchestration, ...) |
products |
No | Workday products touched, from the products list in hub.config.json |
authors |
No | GitHub usernames |
tutorial |
No | An https link to a walkthrough. Adds a Tutorial link to the card. Omit or leave empty if none |
source |
No | Leave it as community (the default). DevRel sets workday on examples authored by Workday teams, which controls the badge in the gallery |
Validate from the repository root with node scripts/validate-examples.mjs.