Skip to content

Commit 4310978

Browse files
authored
Merge pull request #46 from federated-catalogue-enhancements-2026/merge-to-upstream/CAT-SF-04_remove-upload-validation-gate
CAT-FR-SF-04 Align arc42 with upload-path simplification
2 parents 1d230c7 + eebfe9d commit 4310978

6 files changed

Lines changed: 127 additions & 106 deletions

File tree

federated-catalogue/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
# Architecture Document — XFSC Federated Catalogue
1+
# Architecture document for the GXFS Catalogue
2+
3+
## XFSC Federated Catalogue
4+
5+
The rendered architecture document (HTML site + PDF) is produced by the
6+
[`Run docToolchain`](https://github.com/eclipse-xfsc/docs/actions/workflows/buildDocs.yml) workflow on every push to
7+
`main` and uploaded as the `Documentation` artifact (containing
8+
`federated-catalogue/build/pdf/architecture/catalogue-architecture.pdf` and the full `build/html5/` site).
9+
10+
Get the latest rendered docs:
11+
12+
1. Open the [latest successful `Run docToolchain` run on `main`](https://github.com/eclipse-xfsc/docs/actions/workflows/buildDocs.yml?query=branch%3Amain+is%3Asuccess).
13+
2. Scroll to the **Artifacts** section and download `Documentation.zip`.
14+
3. Unzip — open `catalogue-architecture.pdf` for the PDF or `html5/architecture/catalogue-architecture.html` for the website.
15+
16+
> Note: GitHub Actions artifacts expire after 90 days. For a permanent reference, link to the workflow run's commit SHA.
217
318
The architecture is built by
419
the [buildDocs workflow](https://github.com/eclipse-xfsc/docs/actions/workflows/buildDocs.yml) in the

0 commit comments

Comments
 (0)