maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pulumi/developer-docs/index.md

37 lines
652 B
Markdown
Raw Normal View History

Start in on developer documentation. (#7839) Developer documentation is written in Markdown and can be built into HTML, PDF, etc. using Sphinx. Diagrams are written in PlantUML and rendered as SVGs. All developer docs live in the `developer-docs` folder under the root of the repository.
2021-08-26 00:18:13 +02:00
# Pulumi Developer Documentation
Welcome to the Pulumi developer documentation! This documentation provides details on Pulumi internals, including but
not limited to:
- How to build and test Pulumi
- Pulumi architectural details
- Specifications
Use the navigation bar to the left to browse the docs.
```{toctree}
:hidden:
:caption: System Architecture
architecture/overview
architecture/resource-registration
[apitype] Add a JSON schema for deployments. (#8002) This schema can be used to validate the contents of a Pulumi deployment. If a deployment validates against this schema, it should be considered syntactically valid, though it may contain certain classes of semantic errors (e.g. references to unknown resources in dependency lists, dependency cycles, etc.). This schema is not yet used for validation in practice and may not be entirely accurate. These changes also add this schema (and the schemas on which it depends) to the developer documentation. jsonschema2md.go has been updated to support multi-file schemas.
2021-09-22 06:37:06 +02:00
architecture/deployment-schema
[developer-docs] Add preliminary type system docs. (#8096) Just what it says on the tin: add some initial documentation for the abstract Pulumi type system. Over time, this documentation will be fleshed out to describe the relationship between the abstract type system and its wire representations, Pulumi package schemas, and language SDK implementations. Co-authored-by: Andrew Fitzgerald <131809+fitzoh@users.noreply.github.com> Co-authored-by: Ian Wahbe <ian@wahbe.com>
2021-09-30 00:01:50 +02:00
architecture/type-system
[developer-docs] Document resource import. (#8137) These changes add a page to the developer docs that describes the design and implementation of the `import` resource option and the `pulumi import` command. Co-authored-by: Levi Blackstone <levi@pulumi.com>
2021-10-07 21:14:37 +02:00
architecture/import
Start in on developer documentation. (#7839) Developer documentation is written in Markdown and can be built into HTML, PDF, etc. using Sphinx. Diagrams are written in PlantUML and rendered as SVGs. All developer docs live in the `developer-docs` folder under the root of the repository.
2021-08-26 00:18:13 +02:00
```
```{toctree}
:hidden:
:caption: Resource Providers
providers/implementers-guide
[schema] Add the Pulumi Package metaschema. (#7952) The Pulumi Package metaschema is a JSON schema definition that describes the format of a Pulumi Package schema. The metaschema can be used to validate certain basic properties of a Pulumi Package schema, including (but not limited to): - data types (e.g. is this property a string?) - data formats (e.g. is this string property a valid regex?) - object shapes (e.g. is this object missing required properties?) The schema binder has been updated to use the metaschema as its first validation pass. In addition to its use in the binder, the metaschema has its own page in the developer documentation. This page is generated using a small tool, jsonschema2md.go.
2021-09-20 21:00:42 +02:00
providers/metaschema
Start in on developer documentation. (#7839) Developer documentation is written in Markdown and can be built into HTML, PDF, etc. using Sphinx. Diagrams are written in PlantUML and rendered as SVGs. All developer docs live in the `developer-docs` folder under the root of the repository.
2021-08-26 00:18:13 +02:00
```
```{toctree}
:hidden:
:caption: Meta
build
```
Reference in a new issue Copy permalink