Skip to content

Commit 47197cb

Browse files
committed
refactor: move Antora site from manual/ into docs/
- Playbook, package.json, and content under docs/; integrate maintainer guide as AsciiDoc page - Rename workflow to publish-docs.yml; ignore docs/build and docs/node_modules - Remove standalone publishing-marketplace.md (content lives in the published site nav) Made-with: Cursor
1 parent 6f36551 commit 47197cb

22 files changed

Lines changed: 33 additions & 34 deletions
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
name: Publish the manual
1+
name: Publish docs site
22

33
on:
44
push:
55
branches: [main]
66
paths:
7-
- 'manual/**'
8-
- '.github/workflows/publish-the-manual.yml'
7+
- 'docs/**'
8+
- '.github/workflows/publish-docs.yml'
99
workflow_dispatch:
1010
schedule:
1111
- cron: '0 6 * * *'
@@ -30,28 +30,28 @@ jobs:
3030
- uses: pnpm/action-setup@v4
3131
with:
3232
version: 10.33.0
33-
package_json_file: manual/package.json
33+
package_json_file: docs/package.json
3434

3535
- uses: actions/setup-node@v4
3636
with:
3737
node-version: 20
3838
cache: pnpm
39-
cache-dependency-path: manual/pnpm-lock.yaml
39+
cache-dependency-path: docs/pnpm-lock.yaml
4040

4141
- name: Install dependencies
42-
working-directory: manual
42+
working-directory: docs
4343
run: pnpm install --frozen-lockfile
4444

45-
- name: Build the manual site
46-
working-directory: manual
45+
- name: Build the docs site
46+
working-directory: docs
4747
run: pnpm exec antora antora-playbook.yml
4848

4949
- name: Ensure .nojekyll
50-
run: touch manual/build/site/.nojekyll
50+
run: touch docs/build/site/.nojekyll
5151

5252
- uses: actions/upload-pages-artifact@v3
5353
with:
54-
path: manual/build/site
54+
path: docs/build/site
5555

5656
deploy:
5757
needs: build

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
manual/build/
2-
manual/node_modules/
1+
docs/build/
2+
docs/node_modules/

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ The **full manual** (multi-page, Antora-generated) is published here:
55

66
https://antora-supplemental.github.io/antora-build-action/
77

8-
AsciiDoc sources and the playbook live in the `manual/` directory of this repository.
8+
AsciiDoc sources and the Antora playbook live in the `docs/` directory of this repository.
99

1010
The https://github.com/marketplace[GitHub Marketplace] listing is generated from `README.md` only.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**https://antora-supplemental.github.io/antora-build-action/**
88

9-
The manual covers prerequisites, every input/output, authentication for private `content.sources`, multi-repo examples, official vs peaceiris Pages patterns, security, and troubleshooting. Source lives under `manual/` in this repository.
9+
The manual covers prerequisites, every input/output, authentication for private `content.sources`, multi-repo examples, official vs peaceiris Pages patterns, security, and troubleshooting. Source lives under `docs/` in this repository (AsciiDoc playbook + `content/`).
1010

1111
> GitHub Marketplace ingests **this `README.md` only** (Markdown). Keep this file short; put depth in the manual.
1212
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ site:
55

66
content:
77
sources:
8-
# Playbook lives in manual/; component root is manual/content (repo root is parent).
8+
# Playbook in docs/; Antora component is docs/content (repo root is parent for git).
99
- url: ..
1010
branches: HEAD
11-
start_path: manual/content
11+
start_path: docs/content
1212

1313
output:
1414
dir: ./build/site
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@
1414
* xref:security.adoc[Security]
1515
* xref:troubleshooting.adoc[Troubleshooting]
1616
* xref:contributing.adoc[Contributing & legal]
17+
* Maintainers
18+
** xref:publishing-marketplace.adoc[Publishing to Marketplace]
File renamed without changes.
File renamed without changes.

manual/content/modules/ROOT/pages/explanation-pages-actions.adoc renamed to docs/content/modules/ROOT/pages/explanation-pages-actions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ GitHub Pages can be updated in more than one way:
88
99
**Antora Site Builder** intentionally **does not** choose a deploy mechanism: it runs Antora and exposes `site-path` so you can plug in whichever pattern your org standardizes on.
1010

11-
**GitHub Marketplace** does **not** forbid `.github/workflows/` in an action repository: CI, tests, and lint workflows for the action itself are common. What you do **not** get is a workflow that automatically appears in a consumer’s repo—users add their own workflows and `uses:` your action. This repository publishes the **HTML manual** to GitHub Pages via `.github/workflows/publish-the-manual.yml`. Maintainer notes: https://github.com/antora-supplemental/antora-build-action/blob/main/docs/publishing-marketplace.md[publishing-marketplace.md].
11+
**GitHub Marketplace** does **not** forbid `.github/workflows/` in an action repository: CI, tests, and lint workflows for the action itself are common. What you do **not** get is a workflow that automatically appears in a consumer’s repo—users add their own workflows and `uses:` your action. This repository publishes this documentation site to GitHub Pages via `.github/workflows/publish-docs.yml`. Maintainer checklist: xref:publishing-marketplace.adoc[Publishing to Marketplace].

0 commit comments

Comments
 (0)