Skip to content

Commit 19dd95b

Browse files
committed
docs(README): update README add Getting Started and Examples
1 parent 434d075 commit 19dd95b

File tree

1 file changed

+16
-25
lines changed

1 file changed

+16
-25
lines changed

README.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
Terraform Provider For ZStack Cloud
22
==================
33

4-
- Tutorials: [learn.hashicorp.com](https://learn.hashicorp.com/terraform?track=getting-started#getting-started)
5-
- Documentation:
4+
- [Getting Started](https://registry.terraform.io/providers/ZStack-Robot/zstack/latest)
5+
- Usage
6+
- Documentation
7+
- [Examples](https://github.com/ZStack-Robot/terraform-provider-zstack/blob/main/docs/index.md)
68

9+
The ZStack provider is used to interact with the resources supported by ZStack Cloud, a powerful cloud management platform.
10+
This provider allows you to manage various cloud resources such as virtual machines, networks, storage, and more.
11+
It provides a seamless integration with Terraform, enabling you to define and manage your cloud infrastructure as code.
712

813
Supported Versions
914
------------------
@@ -28,36 +33,22 @@ Using the provider
2833
Please see [instructions](https://www.zstack.io) on how to configure the ZStack Cloud Provider.
2934

3035

31-
## Developing the Provider
32-
---------------------------
36+
## Contributing to the provider
3337

34-
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.20+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
35-
36-
To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
37-
38-
```sh
39-
$ make build
40-
...
41-
$ $GOPATH/bin/terraform-provider-zstack
42-
...
43-
```
38+
The ZStack Provider for Terraform is the work of many contributors. We appreciate your help!
4439

45-
Running `make dev` or `make devlinux` or `devwin` will only build the specified developing provider which matchs the local system.
46-
And then, it will unarchive the provider binary and then replace the local provider plugin.
40+
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.20+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
4741

48-
In order to test the provider, you can simply run `make test`.
4942

50-
```sh
51-
$ make test
52-
```
5343

54-
In order to run the full suite of Acceptance tests, run `make testacc`.
44+
You may also [report an issue](https://github.com/ZStack-Robot/terraform-provider-zstack/issues/new).
5545

56-
*Note:* Acceptance tests create real resources, and often cost money to run.
46+
Here is an example of how to clone this repository and switch to the directory:
5747

58-
```sh
59-
$ make testacc
60-
```
48+
```console
49+
$ git clone https://github.com/ZStack-Robot/terraform-provider-zstack.git
50+
$ cd terraform-provider-zstack
51+
```
6152

6253
## Acceptance Testing
6354
Before making a release, the resources and data sources are tested automatically with acceptance tests (the tests are located in the zstack/*_test.go files).

0 commit comments

Comments
 (0)