Skip to content

Sync Funnel documentation from develop - #107

Open
matthewpeterkort wants to merge 5 commits into
mainfrom
feature/sync-funnel-docs-develop
Open

matthewpeterkort wants to merge 5 commits into
mainfrom
feature/sync-funnel-docs-develop

Conversation

@matthewpeterkort

@matthewpeterkort matthewpeterkort commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

The CALYPR site maintains a separate copy of Funnel documentation. This PR adds an automated, reviewable sync from calypr/funnel's develop branch; it does not change the site's Funnel content directly.

  • Check Funnel develop daily and open or update a PR when its revision changes. The sync tests and builds the site before opening the PR.
  • Convert Funnel's Hugo shortcodes to Zensical-compatible Markdown and generate navigation for the imported pages.
  • Preserve the live GCP Batch, Kubernetes, and S3 guides until their reconciled versions in Address outstanding Funnel issues funnel#1474 reach develop, then adopt them automatically. The CALYPR landing and download pages remain site-owned.
  • Document the source of truth, sync process, and GitHub Actions permissions.

The first sync after Funnel #1474 merges will propose the Badger guide, remote-server guide for calypr/funnel#362, and the reconciled reference pages. The generated PR still needs review and merge before publication.

Validation: sync unit tests, Zensical build, and actionlint passed. A simulated first sync against the Funnel PR branch verified that all three protected guides transfer and that Badger and remote-server pages appear in navigation.

The organization and repository settings for Actions-created PRs are enabled. The scheduled workflow becomes active after this PR merges; PR workflows created with GITHUB_TOKEN may require approval.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-26T22:01:13.190252Z 8e49e30 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8e49e3051b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +69 to +70
with:
branch: automation/sync-funnel-docs

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Exclude Python bytecode from automated documentation commits

Whenever an upstream revision changes, the preceding unittest step creates scripts/__pycache__/ and tests/__pycache__/, neither of which is ignored by .gitignore (confirmed by running the tests locally). This step does not restrict add-paths, whose documented default is that “all new and modified files are added,” so each generated documentation PR also commits those binary build artifacts. Their checkout-dependent timestamps can cause further binary churn on subsequent updates to the open PR. Ignore Python bytecode or restrict the action to the intended documentation and navigation paths. See the action's input documentation.

Useful? React with 👍 / 👎.

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