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

fix doc and remove scaffold #29

Merged
merged 1 commit into from
Jul 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,27 @@ Then, run [`packer init`](https://www.packer.io/docs/commands/init).
packer {
required_plugins {
nutanix = {
version = ">= 0.1.0"
version = ">= 0.1.3"
source = "github.com/nutanix-cloud-native/nutanix"
}
}
}
```

#### Manual installation

You can find pre-built binary releases of the plugin [here](https://github.com/nutanix-cloud-native/packer-plugin-nutanix/releases).
Once you have downloaded the latest archive corresponding to your target OS,
uncompress it to retrieve the plugin binary file corresponding to your platform.
To install the plugin, please follow the official Packer documentation on [installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).


#### From Source

If you prefer to build the plugin from its source code, clone the GitHub repository locally and run the command `make build` from the root directory.
Upon successful compilation, a `packer-plugin-nutanix` plugin binary file can be found in the root directory.
To install the compiled plugin, please follow the official Packer documentation on [installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).

### Configuration

For more information on how to configure the plugin, please find some examples in the [`example/`](example) directory.
Expand Down
78 changes: 0 additions & 78 deletions docs/README.md

This file was deleted.

63 changes: 0 additions & 63 deletions docs/builders/builder-name.mdx

This file was deleted.

78 changes: 0 additions & 78 deletions docs/datasources/datasource-name.mdx

This file was deleted.

59 changes: 0 additions & 59 deletions docs/post-processors/postprocessor-name.mdx

This file was deleted.

62 changes: 0 additions & 62 deletions docs/provisioners/provisioner-name.mdx

This file was deleted.