Skip to content

Commit 7c3a7fe

Browse files
committed
Update with instructions to release offline docs
1 parent 4769da3 commit 7c3a7fe

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,50 @@ all generated sources in the project first.
453453

454454
Of course this then takes some more time than an optimized rebuild (time to grab another coffee!).
455455

456+
## Generating Offline Documentation Bundles
457+
458+
After a Camel release, maintainers can generate a versioned offline documentation bundle
459+
and publish it as a GitHub Release asset. This is useful for AI coding agents or
460+
environments with restricted internet access.
461+
462+
The workflow is defined in [`.github/workflows/offline-bundle.yml`](.github/workflows/offline-bundle.yml).
463+
464+
### Triggering the workflow
465+
466+
1. Go to **Actions** in this repository
467+
2. Select **"Generate Offline Documentation Bundle"** in the left sidebar
468+
3. Click **"Run workflow"**
469+
4. Enter the Camel version to bundle (e.g. `4.18`) — use the major.minor version only, no patch, no `v` prefix
470+
5. Click **"Run workflow"**
471+
472+
Or trigger it from the command line using the [GitHub CLI](https://cli.github.com/):
473+
474+
$ gh workflow run offline-bundle.yml -f camel_version=4.18
475+
476+
### What the workflow does
477+
478+
1. Checks out the repository and builds the full website (`yarn build`)
479+
2. Runs `scripts/generate-offline-bundle.js` which:
480+
- Collects version-specific `.md` files from `public/components/<version>.x/` and `public/manual/`
481+
- Fetches the Camel Catalog (JSON metadata for all connectors, data formats, languages, and EIPs) from the `camel-<version>.x` branch in [`apache/camel`](https://github.com/apache/camel) via the GitHub API
482+
- Fetches the YAML DSL canonical JSON Schema
483+
- Includes `llms.txt` if present
484+
- Zips everything into `camel-docs-<version>.zip`
485+
3. Creates (or replaces) a GitHub Release tagged `docs-<version>` with the zip as an asset
486+
487+
### Output
488+
489+
The bundle is published at:
490+
491+
https://github.com/apache/camel-website/releases/tag/docs-<version>
492+
493+
For example, the 4.18 bundle would be at `https://github.com/apache/camel-website/releases/tag/docs-4.18`.
494+
495+
### When to run
496+
497+
Trigger this after each Camel release. For example, when Camel `4.18.1` ships, run the workflow
498+
with version `4.18` to update the `docs-4.18` bundle with the latest documentation.
499+
456500
## Search Indexing Configuration
457501

458502
The website uses [Algolia DocSearch](https://docsearch.algolia.com/) to provide site-wide search functionality. The search configuration is defined in [`.docsearch.config.json`](.docsearch.config.json).

0 commit comments

Comments
 (0)