Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation. #55

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add documentation. #55

wants to merge 3 commits into from

Conversation

schmidtw
Copy link
Collaborator

@schmidtw schmidtw commented Nov 8, 2023

No description provided.

@schmidtw schmidtw requested a review from ringods November 8, 2023 04:02
@schmidtw
Copy link
Collaborator Author

schmidtw commented Nov 8, 2023

@ringods I'm not strong at either python or typescript so I left those blank.

docs/_index.md Outdated
---
title: VMware VRA
meta_desc: Provides an overview of the VMware VRA Provider for Pulumi.
layout: overview
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must be layout: package

---
title: VRA Installation & Configuration
meta_desc: Information on how to install the VRA provider.
layout: installation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must be layout: package

docs/_index.md Outdated

## Example

{{< chooser language "typescript,python,go,csharp" >}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a yaml example?


```python

// I'm not sure.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you start from the yaml example above, you can use pulumi convert to generate for languages you are less familiar with yourself.

https://www.pulumi.com/blog/pulumi-yaml-ga/#full-support-for-pulumi-convert

* Python: [`pulumiverse_vra`](https://pypi.org/project/pulumiverse-vra/)
* Go: [`github.com/pulumiverse/pulumi-vra/sdk/go/vra`](https://pkg.go.dev/github.com/pulumiverse/pulumi-vra/sdk)
* .NET: [`Pulumiverse.VRA`](https://www.nuget.org/packages/Pulumiverse.VRA)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a section here explaining how to manually install the plugin binary?

Here is the snippet from the Talos provider as an example:

https://github.com/pulumiverse/pulumi-talos/blob/f64635341c178019cd59f9a72819d56d5c29f6b0/docs/installation-configuration.md#L16-L23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants