Repository navigation
Move Momentum docs to the private momentum-docs submodule - #877
Merged
Merged
Conversation
✅ Deploy Preview for support-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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. |
dkoerichbird
approved these changes
Oct 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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 asmaintoday, 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.tomlsets the build commandnpm run build, the same command as the Netlify UI..github/actions/momentum-docsaction and the secretMOMENTUM_DOCS_SSH_KEY.NEXT_PUBLIC_ALGOLIA_MOMENTUM_INDEX, so momentum-docs previews can search their own index. When it is unset, the site and the indexer usenext_momentum_documentationas before.pdf-buildreads the manuals through the submodule, and stops with an error if the submodule has not been fetched.Known costs
git submodule update --initbeforenpm run devornpm run build, which needs read access to momentum-docs.Testing
mainside by side. Both produced the same 3,438 pages, and the remaining byte-level differences were build-to-build noise.🤖 Generated with Claude Code