mirror of https://github.com/pulumi/pulumi.git
1cd86ddee1
This commit makes a few changes to our developer documentation in order to make way for pulumi/pulumi-terraform-bridge#2623, which adds Sphinx developer documentation to the Terraform Bridge. Namely: * We introduce `intersphinx`, which allows for cross-referencing between multiple Sphinx documentation sites as though they were in one site. We won't introduce such links until the bridge documentation is merged and deployed, but in theory links such as `tfbridge:some-label` will resolve correctly thereafter. * We rename the root page from "Home", to "Pulumi developer documentation", since both the `pulumi/pulumi` and bridge documentation sites will have a root and it could be confusing if they were both called "Home". * While we're here, we copy a trick from the bridge PR that allows us to just write Mermaid diagrams using `mermaid` instead of `{mermaid}`. This means that GitHub will render them in our Markdown files, which is nice. |
||
|---|---|---|
| .. | ||
| architecture | ||
| references | ||
| sphinx | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| diagrams.md | ||
| documentation.md | ||
| make.py | ||
| requirements.txt | ||
| writing.md | ||
README.md
Pulumi developer documentation
Welcome to the Pulumi developer documentation! This site is designed to provide complete documentation for maintainers of and contributors to Pulumi.
:::{toctree} :maxdepth: 2 :titlesonly:
Home /docs/documentation /docs/architecture/README /docs/references/README :::