Embed Tableau was created with Nextra, a documentation template built with the Nextjs web framework that uses React to generate cutting-edge static webapps while content is written in Markdown, an industry standard language for documentation. The app can be hosted on Nextjs or self-hosted with Docker.
This architecture was selected for the following reasons:
- React is great for creating dynamic UI elements such as Tableau embeds that fit seamlessly within product documentation. It's popularity makes it easier to find developers who can contribute to the codebase or teach others how to do so. Nextjs is the most popular React metaframework known for some of the highest rated developer experiences out there.
- Markdown is a commonly used lightweight markup language that allows technical writers to produce content within a "docs-as-code" framework. This is an established method for application developers and technical writers to work in the most agile way possible with no overhead expenses. It is also the established process for writing technical documentation within this organization.
- Jamstack is the architectural approach that encompasses SSG (static site generation) which allows for the generation of complex and dynamic websites through 'builds' which result in a static app that can be hosted freely or inexpensively on some of the fastest web infrastructure, CDNs.
The combination works great for this use case since it is built to facilitate contributions towards content that fulfill the purpose of this guide while still allowing developers to write a dynamic application with cutting-edge best practices for the web.
Most technical documentation required to configure, alter or enhance this codebase is updated and maintained by professional teams listed here (in order of importance):