Skip to content

docs: add hidden page on operating self-hosted SDK generation#6321

Merged
fern-support merged 5 commits into
mainfrom
devin/1784566169-selfhosted-sdk-ops
Jul 20, 2026
Merged

docs: add hidden page on operating self-hosted SDK generation#6321
fern-support merged 5 commits into
mainfrom
devin/1784566169-selfhosted-sdk-ops

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds an SDKs page, Operations and maintenance, for running self-hosted SDK generation day-to-day, and makes the existing Self-hosted SDKs page the single home for all setup.

Setup consolidation (fern/products/sdks/deep-dives/self-hosted.mdx)

  • Adds a ## Infrastructure requirements section (Docker runtime, FERN_TOKEN, the two outbound endpoints, output write access).
  • Promotes the private-registry content out of the "custom container registry" accordion into a proper ## Private registry setup section: mirror the generator image (docker pull/tag/push), reference it via the image object in generators.yml, authenticate. The Run generation locally step now links to that section.
  • Intro cross-links "infrastructure management, SDK distribution" to the operations page.

New page (fern/products/sdks/deep-dives/self-hosted-operations.mdx) — listed under Self-hosting, focused on maintenance + distribution:

  • Ongoing maintenance: keeping generator/CLI versions current, computing versions per release, distributing the SDK, rotating credentials. Links back to setup for infrastructure requirements and re-mirroring.
  • Distributing to your clients securely (npm-centered): restricted scoped package, OIDC/trusted publishing + provenance, registry-hosting options (private npm scope vs. Verdaccio/GitHub Packages/Artifactory/CodeArtifact), per-client scoped read tokens + client .npmrc, dist-tags/npm deprecate to steer versions, client-side pinning + npm audit signatures, and npm pack tarball delivery for air-gapped clients.

Registered in fern/products/sdks/sdks.yml under the existing Self-hosting section (not hidden). Also fixed a stray http://localhost:3000 link in the setup page.

fern check --warnings passes (0 errors); Vale passes on the edited pages.

Link to Devin session: https://app.devin.ai/sessions/3e0bbfb5d5944f37a17cfa3dadfc2745

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot requested a review from devalog as a code owner July 20, 2026 16:49
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

jon-postman and others added 2 commits July 20, 2026 17:00
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
…, air-gap)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@fern-support
fern-support enabled auto-merge (squash) July 20, 2026 19:03
jon-postman and others added 2 commits July 20, 2026 19:21
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@fern-support
fern-support merged commit 3f90e58 into main Jul 20, 2026
4 checks passed
@fern-support
fern-support deleted the devin/1784566169-selfhosted-sdk-ops branch July 20, 2026 19:27
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.

3 participants