Skip to content

Add the arcadedb-python component as a content source and rebuild daily - #505

Open
tae898 wants to merge 1 commit into
ArcadeData:mainfrom
tae898:docs/arcadedb-python-component
Open

tae898 wants to merge 1 commit into
ArcadeData:mainfrom
tae898:docs/arcadedb-python-component

Conversation

@tae898

@tae898 tae898 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Part of #502. This is the playbook side of the separate-component proposal in the second comment of that issue: the Python bindings' docs become a second Antora component, arcadedb-python, published at docs.arcadedb.com/arcadedb-python/, and their AsciiDoc lives in ArcadeData/arcadedb-python under docs/, next to the code. The component skeleton and a first slice of pages are in ArcadeData/arcadedb-python#23.

What changes

  • antora-playbook.yml: one more entry under content.sources, url: https://github.com/ArcadeData/arcadedb-python.git, branches: main, start_path: docs. The site, theme and Pagefind search stay one.
  • .github/workflows/cloudflare-deploy.yml: a schedule trigger (daily, 04:17 UTC). workflow_dispatch was already there. The deploy step ran only on push, so a scheduled or manual run would have built the site and thrown it away. It now runs on every event except pull_request, still only on main.

Rebuild trigger, and the trade-off. Antora fetches the remote source at build time, so the site shows the state of arcadedb-python main at the last build. The daily schedule needs no secret and no token on either side: a change in arcadedb-python reaches the site within a day, and anyone with write access here can run the workflow by hand to publish sooner. The alternative is a repository_dispatch from arcadedb-python on each docs change, which makes the site update within minutes but needs a token with write access to this repository stored as a secret in arcadedb-python. I left it out on purpose; it can be added later without touching this playbook. One scheduled run a day costs one build of a few minutes (the same as a push to main).

Merge order. Merge ArcadeData/arcadedb-python#23 first. A source without docs/antora.yml makes the Antora build fail, so this PR's check goes green only after that one is on main.

#503. The how-to page how-to/connectivity/python-embedded.adoc in #503 stays in the arcadedb component as the entry point, and this PR does not touch or duplicate it. Once both are merged, that page can link to the component with xref:arcadedb-python::index.adoc[]; I will send that one-line change then.

Checked locally. A build with a temporary playbook (outside both repos) whose sources are this branch and the arcadedb-python branch of #23 renders build/site/arcadedb-python/index.html, installation.html, quickstart.html and how-to/databases-and-queries.html, with the component's nav, and the arcadedb component still builds with the same warnings as on main. docs-validator.py output is identical to main (the 2 anchor issues in sql-functions.adoc, the 3 broken xrefs, 40 orphan warnings), since this PR changes no AsciiDoc. The scheduled and deploy changes can only be exercised on GitHub.

For the maintainers to decide

  • Separate component (this PR) or the pages appended to the arcadedb component. The component keeps the bindings' versions apart from the engine's; appending keeps one place to edit.
  • The schedule: daily at 04:17 UTC, or another cadence, or the dispatch route above.
  • Whether a manual run on main should deploy (it does here).

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mergify

mergify Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant