Update docs #234
Update docs #234
Conversation
corymhall
force-pushed
the
corymhall/update-docs-2
branch
from
7dd6c0e to
adf3e76
Compare
README.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| ### L2 Example |
There was a problem hiding this comment.
What does L2 exactly stand for in this case?
It seems like the test is importing a CDK resource created by the pulumi provider, what is L2 here?
There was a problem hiding this comment.
In this case "importing" more accurately means "casting". CDK L2s do not take string values, they take references to other L2s. This example shows how you can take a Pulumi resource, turn it into a CDK L2 (via fromXXX methods) and pass that as an argument to an L2.
| ## Use Pulumi resources with CDK Constructs | ||
|
|
||
| It is possible to use Pulumi and CDK resources side-by-side. In order to pass a | ||
| Pulumi Output value into a CDK resource you can use the [asString][./api-docs/README.md#asString], [asList][./api-docs/README.md#asList], & |
There was a problem hiding this comment.
asList seems to only handle lists of strings, do we ever need to pass objects? Interetssing.
| @@ -160,7 +637,9 @@ create the following staging resources. | |||
|
|
|||
| See [API Docs](./api-docs/README.md) for more details. | |||
|
|
|||
| ## Building locally | |||
| ## Contributing | |||
There was a problem hiding this comment.
CONTRIBUTING.md probably, this README is getting big.
There was a problem hiding this comment.
I'm going to leave this as a todo. I'll tackle creating a true contributing guide as a separate thing.
corymhall
force-pushed
the
corymhall/update-docs-2
branch
from
adf3e76 to
39d0185
Compare
Adding a bunch of docs to the README.
Let me know if you can think of any other features/use cases that we should cover.