Repository navigation
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 atdocs.arcadedb.com/arcadedb-python/, and their AsciiDoc lives in ArcadeData/arcadedb-python underdocs/, 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 undercontent.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: ascheduletrigger (daily, 04:17 UTC).workflow_dispatchwas already there. The deploy step ran only onpush, so a scheduled or manual run would have built the site and thrown it away. It now runs on every event exceptpull_request, still only onmain.Rebuild trigger, and the trade-off. Antora fetches the remote source at build time, so the site shows the state of
arcadedb-pythonmainat 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 arepository_dispatchfrom 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 tomain).Merge order. Merge ArcadeData/arcadedb-python#23 first. A source without
docs/antora.ymlmakes the Antora build fail, so this PR's check goes green only after that one is onmain.#503. The how-to page
how-to/connectivity/python-embedded.adocin #503 stays in thearcadedbcomponent as the entry point, and this PR does not touch or duplicate it. Once both are merged, that page can link to the component withxref: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.htmlandhow-to/databases-and-queries.html, with the component's nav, and thearcadedbcomponent still builds with the same warnings as onmain.docs-validator.pyoutput is identical tomain(the 2 anchor issues insql-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
arcadedbcomponent. The component keeps the bindings' versions apart from the engine's; appending keeps one place to edit.mainshould deploy (it does here).🤖 Generated with Claude Code