Skip to content

Publish Connectors concept doc#179

Merged
kcmartin merged 11 commits into
mainfrom
publish-connectors-doc
May 14, 2026
Merged

Publish Connectors concept doc#179
kcmartin merged 11 commits into
mainfrom
publish-connectors-doc

Conversation

@vaurdan
Copy link
Copy Markdown
Contributor

@vaurdan vaurdan commented May 14, 2026

Summary

  • Publish the Connectors concept doc by removing the draft: true frontmatter.
  • Drop the "Limited release" callout — connectors are no longer behind a feature flag we need to call out.
  • Add an "API only for now" note in the Endpoint allow- and block-lists section, since the dashboard's Access Configuration card doesn't yet expose allowed_endpoints / blocked_endpoints. Links readers to the public Connectors API reference (added in superfly/sprites-api#579).
  • Unblock CI: add pnpm.onlyBuiltDependencies for cypress, esbuild, and sharp. pnpm 11 was erroring on every recent CI run (ERR_PNPM_IGNORED_BUILDS); this allow-lists the three packages that need to run postinstall scripts.

Test plan

  • CI build passes (was failing on pnpm install for all branches before this fix).
  • pnpm dev and visit http://localhost:4321/concepts/connectors/ to confirm the page renders and appears in the sidebar under Concepts.
  • Confirm the "API only for now" callout renders and the link target is correct.

@vaurdan vaurdan requested a review from kcmartin May 14, 2026 14:38
vaurdan added 3 commits May 14, 2026 14:40
pnpm 11 errors on unapproved postinstall scripts (ERR_PNPM_IGNORED_BUILDS),
which has been failing CI on every branch. Allow-list the three packages
that need to run install/postinstall: cypress, esbuild, sharp.
pnpm 11 reads onlyBuiltDependencies from pnpm-workspace.yaml, not from
the package.json pnpm field — the previous attempt left CI failing with
ERR_PNPM_IGNORED_BUILDS.
pnpm 11 renamed the build-approval setting from onlyBuiltDependencies
to allowBuilds (a map of package -> bool). Without this, install fails
with ERR_PNPM_IGNORED_BUILDS.
The build approval list lives in pnpm-workspace.yaml, so the Dockerfile
needs to copy it alongside package.json — otherwise the Docker build
fails with ERR_PNPM_IGNORED_BUILDS even though GitHub Actions' Build
step succeeds.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

Preview Deployment

Name URL
Preview https://pr-179-superfly-sprites-docs.fly.dev

Commit: 25fa722

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟠 84 🟢 100 🟢 96 🟢 100
/concepts/connectors/ 🟠 87 🟢 100 🟢 100 🟢 100

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

E2E Test Results

✅ Tests success

Ran against: https://pr-179-superfly-sprites-docs.fly.dev

Comment thread pnpm-workspace.yaml
Comment on lines +1 to +4
allowBuilds:
cypress: true
esbuild: true
sharp: true
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

allowBuilds isn't a pnpm setting, so this won't actually unblock CI. The key that resolves ERR_PNPM_IGNORED_BUILDS is onlyBuiltDependencies, and it takes a list:

onlyBuiltDependencies:
  - cypress
  - esbuild
  - sharp

(The PR description mentions pnpm.onlyBuiltDependencies, so the intent was right, just the wrong key/shape landed in the file.) The Dockerfile COPY change is correct and still needed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oh thanks for catching that! Fixing it.

@kcmartin
Copy link
Copy Markdown
Collaborator

Suggest adding a Concepts group after "Getting Started" in src/lib/sidebar.ts:

{
  label: 'Concepts',
  items: [
    { label: 'Connectors', slug: 'concepts/connectors' },
  ],
},

The other concept docs (checkpoints, lifecycle, networking, services) are still draft: true, so the group starts with just Connectors and the rest slot in as they publish.

Copy link
Copy Markdown
Collaborator

@kcmartin kcmartin left a comment

Choose a reason for hiding this comment

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

Left a suggested copy change, a comment, and and a suggestion about the sidebar section for this page

Comment thread src/content/docs/concepts/connectors.mdx Outdated
Co-authored-by: Kristin Martin <kcmartin@users.noreply.github.com>
vaurdan added 2 commits May 14, 2026 15:55
- pnpm-workspace.yaml: the correct pnpm 11 key is onlyBuiltDependencies
  (list of names), not allowBuilds. Builds were green by coincidence,
  not because the scripts were running.
- sidebar: add a Concepts group with Connectors, between Getting
  Started and CLI Reference. Other concept docs are still draft and
  will slot in here as they publish.
pnpm 11.0 removed onlyBuiltDependencies entirely and replaced it with
allowBuilds (a map of package name -> bool). CI uses pnpm 11.1.2, where
the old key is silently ignored and install errors with
ERR_PNPM_IGNORED_BUILDS.
@vaurdan
Copy link
Copy Markdown
Contributor Author

vaurdan commented May 14, 2026

@kcmartin thank you so much for your feedback! Addressed :)

@vaurdan vaurdan requested a review from kcmartin May 14, 2026 16:03
Copy link
Copy Markdown
Collaborator

@kcmartin kcmartin left a comment

Choose a reason for hiding this comment

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

LGTM!

@kcmartin kcmartin merged commit 7558324 into main May 14, 2026
5 checks passed
@kcmartin kcmartin deleted the publish-connectors-doc branch May 14, 2026 17:37
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