From 0b2d3a982302c3e5097eb5a2ea165ad0edd8dff9 Mon Sep 17 00:00:00 2001 From: Will Date: Wed, 21 Dec 2022 04:47:40 +0000 Subject: [PATCH] Updating documentation --- Makefile | 4 ++-- VERSION | 2 +- docs/data-sources/whatsmyip.md | 24 +++++++++++++----------- docs/index.md | 11 ++++------- examples/main.tf | 4 ++-- terraform-bundle.hcl | 2 +- 6 files changed, 23 insertions(+), 24 deletions(-) diff --git a/Makefile b/Makefile index 00ee5bd..f017dcb 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,9 @@ TEST?=$$(go list ./... | grep -v 'vendor') HOSTNAME=hashicorp.com -NAMESPACE=wdew +NAMESPACE=dewhurstwill NAME=whatsmyip BINARY=terraform-provider-${NAME} -VERSION=1.0.1 +VERSION=1.0.3 OS_ARCH=darwin_arm64 default: install diff --git a/VERSION b/VERSION index e6d5cb8..e4c0d46 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.2 \ No newline at end of file +1.0.3 \ No newline at end of file diff --git a/docs/data-sources/whatsmyip.md b/docs/data-sources/whatsmyip.md index cf04a73..fedd287 100644 --- a/docs/data-sources/whatsmyip.md +++ b/docs/data-sources/whatsmyip.md @@ -1,25 +1,27 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "whatsmyip Data Source - whatsmyip" +page_title: "What's my IP" subcategory: "" description: |- --- -# whatsmyip (Data Source) +# Example +```hcl +provider "whatsmyip" {} +data "whatsmyip" "public_ip" {} +output "value" { + value = data.whatsmyip.public_ip +} +``` +### Attributes - -## Schema - -### Read-Only - -- `cc` (String) -- `country` (String) - `id` (String) The ID of this resource. -- `ip` (String) - +- `ip` (String) Your current public IP +- `country` (String) IP country location in English language +- `cc` (String) Two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format diff --git a/docs/index.md b/docs/index.md index da2bab0..9101f63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,13 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "whatsmyip Provider" +page_title: "What's my IP" subcategory: "" description: |- --- -# whatsmyip Provider +# What's my IP +A terraform provider to get your public IP - - - - -## Schema +> Service provided by [myip.com](https://www.myip.com/) \ No newline at end of file diff --git a/examples/main.tf b/examples/main.tf index cc985b4..7ebc566 100644 --- a/examples/main.tf +++ b/examples/main.tf @@ -1,8 +1,8 @@ terraform { required_providers { whatsmyip = { - version = "0.0.1" - source = "hashicorp.com/wdew/whatsmyip" + version = "1.0.3" + source = "dewhurstwill/whatsmyip" } } } diff --git a/terraform-bundle.hcl b/terraform-bundle.hcl index 04077a8..3a97371 100644 --- a/terraform-bundle.hcl +++ b/terraform-bundle.hcl @@ -3,5 +3,5 @@ terraform { } providers { - whatsmyip = ["1.0.2"] + whatsmyip = ["1.0.3"] }