Commit Graph

9 Commits

Author SHA1 Message Date
susanev 031b2958f1 fix some links
Signed-off-by: susanev <susan.ra.evans@gmail.com>
2023-05-19 19:39:26 -07:00
Pat Gavlin 3a545de34a
[developer-docs] Document resource import. ()
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 12:14:37 -07:00
Pat Gavlin 10816d6414 [developer-docs] Change some type system terms.
- Remove a reference to monads
- s/type constructor/type function/
2021-09-30 09:51:34 -07:00
Pat Gavlin aeaeb1fbb9
[developer-docs] Add preliminary type system docs. ()
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-29 15:01:50 -07:00
Pat Gavlin 134d7cb818
[apitype] Add a JSON schema for deployments. ()
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-21 21:37:06 -07:00
Emiliza Gutierrez c7614f5066
fix typos in dev docs ()
* typo fixes and styling

* fix typos
2021-08-27 21:18:39 -07:00
Pat Gavlin a5a818b802
[developer-docs] Add links + a broad arch diagram ()
- Add links within the resource registration docs
- Add a broad-strokes architectural diagram to the overview
- Add a `clean` target to the Makefile
- Expand the "Building" docs a bit
2021-08-27 10:55:06 -07:00
Levi Blackstone 96e6eb2592
Fix typos () 2021-08-26 11:29:56 -07:00
Pat Gavlin 98f73cf1ed
Start in on developer documentation. ()
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-25 15:18:13 -07:00