Repository navigation
Add the arcadedb-python component as a content source and rebuild daily - #505
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again. |
|
@robfrank could you have a look at this one when you have a moment? It adds the |
…dedb-python This reverts commit 7816049. The site belongs at docs.arcadedb.com/arcadedb-python (ArcadeData/arcadedb-docs#505), not arcadedata.com/arcadedb-python; Pages is disabled again on this repository and the github-pages environment it created is removed. The Docs workflow keeps building the component and attaching the preview artifact. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@lvca @robfrank can we publish the Python bindings' docs at Edited: shortened to the one question; an earlier version also offered a subdomain as an alternative. |
…ery docs change (#115) * docs: build the Antora component as a site of its own, check it on every docs change docs.arcadedb.com does not publish the component yet (ArcadeData/arcadedb-docs#505), and the test workflows ignore docs/** and *.adoc, so nothing built the pages and a docs-only PR had no check. - docs/antora-playbook.yml: standalone site with the UI bundle and asciidoc attributes of the arcadedb-docs playbook; attribute-missing warn and failure level warn. - docs.yml: Antora 3.2.1 (same as arcadedb-docs) on push/PR touching docs/, uploads docs-site. - The 13 xref:arcadedb:: links become {arcadedb-docs-url}/<page> (attribute in antora.yml); the 10 target pages and 4 anchors were checked live on docs.arcadedb.com, a bogus page gives 404. - README, ci.adoc and CLAUDE.md describe the workflow and the link rule. Closes #114 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs playbook: make the content source path relative to the playbook Antora resolves a bare .. from the working directory (CI: /home/runner/work/arcadedb-python, not a git repository); a path that starts with ./ is relative to the playbook file. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: deploy the site from main to GitHub Pages (arcadedata.com/arcadedb-python) Pages is enabled with source "GitHub Actions" (build_type workflow); the github-pages environment allows main only. arcadedata.com is the org Pages domain (behind Cloudflare; arcadedata.com/arcadedb-docs/ already serves a project site), so the project site lands at https://arcadedata.com/arcadedb-python/. The build job uploads the Pages artifact on main only; the deploy job runs actions/deploy-pages v5.0.1. site.url set for the sitemap. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Revert the GitHub Pages deploy: the docs go to docs.arcadedb.com/arcadedb-python This reverts commit 7816049. The site belongs at docs.arcadedb.com/arcadedb-python (ArcadeData/arcadedb-docs#505), not arcadedata.com/arcadedb-python; Pages is disabled again on this repository and the github-pages environment it created is removed. The Docs workflow keeps building the component and attaching the preview artifact. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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, now merged.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. ArcadeData/arcadedb-python#23 is merged, so
docs/antora.ymlis on that repository'smainand this PR does not wait for another merge. (A source withoutdocs/antora.ymlmakes the Antora build fail.)#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