Skip to content

Commit 41c355c

Browse files
committed
Show the gallery with screenshots while there is no hosted version
1 parent 97cfb02 commit 41c355c

3 files changed

Lines changed: 15 additions & 9 deletions

File tree

.github/images/example-page.png

113 KB
Loading

.github/images/gallery.png

104 KB
Loading

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
Browse working examples, copy them into your own projects, and contribute your own.
1010

1111
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-2da44e.svg)](CONTRIBUTING.md)
12-
[![Gallery](https://img.shields.io/badge/gallery-browse-0875e1.svg)](https://workday.github.io/Developer-Relations)
12+
[![Gallery](https://img.shields.io/badge/gallery-browse-0875e1.svg)](#browse-visually-optional)
1313
[![Maintained by DevRel](https://img.shields.io/badge/maintained%20by-Workday%20DevRel-0875e1.svg)](#community-and-support)
1414

15-
[**Browse the gallery**](https://workday.github.io/Developer-Relations) · [Use an example](#use-an-example) · [Contribute](#contributing)
15+
[**Browse the gallery**](#browse-visually-optional) · [Use an example](#use-an-example) · [Contribute](#contributing)
1616

1717
</div>
1818

@@ -42,11 +42,11 @@ hub.config.json Repo URLs and the approved type, component, and product
4242

4343
## Example types
4444

45-
- 🧩 **[Extend App](https://workday.github.io/Developer-Relations/?type=Extend%20App)**: full app source built in App Builder, ready to import into your development tenant.
46-
- 🔌 **[Integration App](https://workday.github.io/Developer-Relations/?type=Integration%20App)**: orchestration-driven integrations connecting Workday to other systems.
47-
- ⚙️ **[Orchestration](https://workday.github.io/Developer-Relations/?type=Orchestration)**: focused orchestration definitions for Orchestration Builder.
48-
- 🤖 **[Agent Skill](https://workday.github.io/Developer-Relations/?type=Agent%20Skill)**: agent skills and instructions, written as markdown.
49-
- 📄 **[Reference](https://workday.github.io/Developer-Relations/?type=Reference)**: design patterns, diagrams, and other material worth copying.
45+
- 🧩 **Extend App**: full app source built in App Builder, ready to import into your development tenant.
46+
- 🔌 **Integration App**: orchestration-driven integrations connecting Workday to other systems.
47+
- ⚙️ **Orchestration**: focused orchestration definitions for Orchestration Builder.
48+
- 🤖 **Agent Skill**: agent skills and instructions, written as markdown.
49+
- 📄 **Reference**: design patterns, diagrams, and other material worth copying.
5050

5151
## Use an example
5252

@@ -90,13 +90,19 @@ The full guide is in [CONTRIBUTING.md](CONTRIBUTING.md).
9090

9191
## Browse visually (optional)
9292

93-
The [`site/`](site) folder holds a gallery that renders every example as a card with search and type filters. Nothing in the repo depends on it; the examples are fully usable without it. To run it locally:
93+
The [`site/`](site) folder holds a gallery that renders every example as a card with search and type filters, and every example gets its own page built from its README. Nothing in the repo depends on it; the examples are fully usable without it.
94+
95+
![The gallery](.github/images/gallery.png)
96+
97+
![An example page](.github/images/example-page.png)
98+
99+
To run it locally:
94100

95101
```bash
96102
cd site && npm install && npm run dev
97103
```
98104

99-
To publish it, enable GitHub Pages in the repo settings (source: GitHub Actions) once. After that, every merge that touches `examples/`, `site/`, or `hub.config.json` rebuilds and redeploys the gallery automatically, so new examples show up on their own. The "Deploy gallery" workflow can also be run manually from the Actions tab for a one-off redeploy.
105+
There is no hosted version while this repository is private. Once it is public, enable GitHub Pages (source: GitHub Actions) and the deploy workflow takes it from there, redeploying automatically whenever examples change.
100106

101107
## Community and support
102108

0 commit comments

Comments
 (0)