Skip to content

Move Momentum docs to the private momentum-docs submodule - #877

Merged
juliebin merged 3 commits into
mainfrom
1765-momentum-docs-submodule
Oct 16, 2026
Merged

juliebin merged 3 commits into
mainfrom
1765-momentum-docs-submodule

Conversation

@juliebin

Copy link
Copy Markdown
Contributor

Part of SparkPost/Momentum#1765.

Background
Every merge to this repository publishes to docs.sparkpost.com. Momentum is on-premises, and its docs must not describe a feature before that release ships, so Momentum doc PRs have had to wait unmerged until release time.

Change

  • content/momentum/ becomes a git submodule of the private repository SparkPost/momentum-docs. It is pinned to a commit with the same content as main today, so the published site does not change. Momentum doc changes now merge in momentum-docs; publishing a release means moving this submodule to the release's tag.
  • netlify.toml sets the build command npm run build, the same command as the Netlify UI.
  • The Cypress, Lighthouse and Algolia index workflows fetch the submodule with a read-only deploy key, through the new .github/actions/momentum-docs action and the secret MOMENTUM_DOCS_SSH_KEY.
  • The Momentum search index name can be set with NEXT_PUBLIC_ALGOLIA_MOMENTUM_INDEX, so momentum-docs previews can search their own index. When it is unset, the site and the indexer use next_momentum_documentation as before.
  • pdf-build reads the manuals through the submodule, and stops with an error if the submodule has not been fetched.

Known costs

  • Pull requests from forks now fail the Cypress and Lighthouse checks, because GitHub gives them no secrets and they cannot fetch the private submodule.
  • A local clone needs git submodule update --init before npm run dev or npm run build, which needs read access to momentum-docs.

Testing

  • I built this branch and main side by side. Both produced the same 3,438 pages, and the remaining byte-level differences were build-to-build noise.
  • This PR's Netlify Deploy Preview is the first build that fetches the submodule with Netlify's deploy key.

🤖 Generated with Claude Code

@netlify

netlify Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 3fb339f
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6ad00e3661a5bea9bf62ef43
😎 Deploy Preview https://deploy-preview-877--support-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@cursor

cursor Bot commented Oct 14, 2026

Copy link
Copy Markdown

This PR is too large for Bugbot to review. It changes 94,704 lines and 3,635,906 characters. Split the change into smaller pull requests to get a review.

@juliebin
juliebin merged commit 8994178 into main Oct 16, 2026
5 of 6 checks passed
@juliebin
juliebin deleted the 1765-momentum-docs-submodule branch October 16, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants