One Docs Site, Many Repos: How OpsMill Builds Infrahub’s Documentation on Docusaurus

OpsMill has developed a decentralized documentation system where each team is responsible for maintaining the documentation alongside the code in their respective repositories, addressing the common issue of outdated documentation due to unclear ownership. This approach utilizes a push-based sync mechanism, identified as Option C, where changes in documentation automatically update a central Docusaurus site, ensuring that the documentation remains current and aligned with the code changes. The system avoids the pitfalls of a monolithic documentation repository and cumbersome git submodule management by allowing each project's documentation to be self-contained while contributing to a unified platform. The setup includes a multi-repo architecture with individual plugin instances for each project within the Docusaurus site, enabling seamless integration and search functionality across projects. This method enhances the consistency and accuracy of the documentation, benefiting customers with up-to-date information and streamlining processes for engineers and new joiners. OpsMill emphasizes the importance of detailed configuration and scripting to maintain consistency across multiple repositories, with the goal of facilitating efficient onboarding and information dissemination.

Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.