Add documentation for staging and production environments #2901
+120
−9
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new section to the "Publishing your docs" page explaining how to set up separate staging and production documentation sites. This addresses a common customer workflow where teams want to preview changes on a staging site before publishing to production.
The new section covers:
docs.yml(with the important note that URLs should not includehttps://)--instanceflag to publish to a specific environmentUpdates since last revision
Enhanced the GitHub workflow examples based on a real customer implementation:
workflow_dispatchtrigger to staging workflow (allows manual triggering in addition to auto-deploy on push)fern checkvalidation step before deploying to catch configuration errors earlyruntodeployfor clarityLocal Testing Completed
fern docs devlocally and verified the new section renders correctlyView original video (rec-1609bf99d0c94acea32f96d3896545fa-edited.mp4)
Review & Testing Checklist for Human
--instanceflag syntax is correct (e.g.,fern generate --docs --instance plantstore-staging.docs.buildwithfern.com)docs.ymlshould NOT includehttps://- this was a key issue discovered in customer supportRecommended test plan: Run
fern docs devlocally and navigate to the Publishing your docs page to verify the new section renders correctly with proper formatting.Notes
https://prefix issue caused publishing failuresLink to Devin run: https://app.devin.ai/sessions/26b48e26643b41edb363c03490d64994
Requested by: Danny Sheridan (@dannysheridan)