Skip to content

PRDCT-538: migrate dev automate/ into help (pilot + converter) - #1020

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
docs/devdocs-migrate-automate
Closed

Iamfle4ka wants to merge 1 commit into
mainfrom
docs/devdocs-migrate-automate

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

What

Pilot for integrating developers.keboola.com into help.keboola.com (the end state is one site). Ports the dev automate/ section (4 pages) faithfully onto this platform and lands the reusable converter that will scale to the rest of the dev docs.

  • scripts/migrate-devdocs.mjs — parameterized Jekyll→Astro converter: permalink→slug (preserves dev paths), strips {: …} / * TOC {:toc} / {% comment %}, converts {% highlight %}→fenced code, dual-copies images (public + co-located), has a collision guard (won't overwrite an existing help page), and never prunes. Reuses the transform ideas from the legacy scripts/migrate.mjs.
  • Ported pages at their existing URLs (dev top-levels don't collide with help): /automate/, /automate/run-job/, /automate/run-orchestration/, /automate/set-schedule/.
  • Links internalized: help.keboola.com/* → relative; the dev "Jobs concept" link → /management/jobs/ (help canonical concept); Orchestrator → /flows/.
  • Nav: new top-level API & Automation group (the future home for extend/ / cli/ / integrate/ as they migrate).

Why this shape

Per the unification playbook, dev content is integrated into help (not kept as a separate site). URL scheme = preserve dev paths (agreed): near-1:1 domain 301s, minimal link churn. This PR validates the converter + scheme on a small section before scaling.

Deferred (by design)

  • /overview/api/ reference link still points at developers.keboola.com — it'll flip to internal when the overview/ section migrates (the "flip inbound links only once the target is migrated" rule).
  • Faithful port only — no Diátaxis rework (the automate/ page title is verbatim). Content reconcile with /flows/ + /management/jobs/ is a later step.

Verification

  • npm run gen:sidebar + npm run build — clean, 262 pages (+4), API & Automation group renders.
  • node scripts/audit-phase2.mjs — no new broken links; MISSING IMAGES: 0 for the ported pages; no leftover Jekyll-isms ({% %} / {: } / permalink:). The one automate/ → developers.keboola.com/overview/api/ seam is the intentional deferred link above.
  • Spot-checked the built pages: images render, code blocks intact, internal links resolve.

Context

Part of the help + developers unification. The dev-docs repo is connected as the devdocs remote, so this is the first mechanical port; the converter scales to integrate/ → overview/ → cli/ → extend/ next.

🤖 Generated with Claude Code

First slice of integrating developers.keboola.com INTO help.keboola.com (one
site). Ports the dev automate/ section faithfully, preserving its URLs, and adds
a reusable converter to scale the rest.

- New scripts/migrate-devdocs.mjs — parameterized Jekyll->Astro converter
  (permalink->slug preserving paths, strips {:..}/{:toc}/{%comment%}, converts
  {%highlight%}, dual-copies images, collision guard, never prunes).
- Port automate/ (index, run-job, run-orchestration, set-schedule) at their
  existing paths; internalize help.keboola.com links; jobs concept -> /management/jobs/.
- New 'API & Automation' nav group (future home for the dev sections).
- overview/api reference link left pointing at dev until overview/ migrates.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jul 14, 2026 1:22pm

Request Review

@Iamfle4ka Iamfle4ka changed the title docs(devdocs): migrate automate/ section onto the platform (pilot + converter) PRDCT-538: migrate dev automate/ into help (pilot + converter) Jul 15, 2026
@linear-code

linear-code Bot commented Jul 15, 2026

Copy link
Copy Markdown

PRDCT-538

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded: migration is being redone as ONE fully script-driven run (no post-script hand edits), per Jordan's requirement that moves be verifiable by validating the code. This PR's scope (and the hand-fixes discovered here) are encoded into the extended script. Placement map for the later topic re-organization: PLACEMENT-MAP.md / https://claude.ai/code/artifact/5333888d-4577-4915-9fab-37fbf3834d47

@Iamfle4ka Iamfle4ka closed this Jul 15, 2026
@jordanrburger

Copy link
Copy Markdown
Contributor

Review summary

Verdict: merge-ready with nits. Merges first (base = main, MERGEABLE); #1021 is stacked on this branch.

Clean pilot (15 files). Four ported pages have valid title+slug frontmatter with unique, non-colliding slugs (automate, automate/run-job, automate/run-orchestration, automate/set-schedule). All internal links resolve; sidebar wired via _data/navigation.yml + regenerated sidebar.mjs.

Nits:

  • scripts/migrate-devdocs.mjs is build tooling, not docs content — a one-time migration script (mirrors scripts/migrate.mjs), not imported by astro.config or any npm script. Harmless to ship, but not exercised by build/CI.
  • No description frontmatter on the 4 pages (AGENTS.md recommends it; feeds search/RAG/meta). title+slug minimum is met.
  • automate/index.md title "Automation/Common Tasks" reads awkwardly (verbatim dev port).

Note: devdocs→help URL 301s are domain-level (separate origin) and out of scope for this repo — confirm those are configured at the developers.keboola.com edge before decommissioning.

Automated review pass (Claude Code), flagged for a human maintainer — not an approval.

This branch was successfully deployed

1 active deployment
Preview — 2e1fa8c8 Deployed Jul 14, 2026 by vercel[bot]
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.

2 participants