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

Updates developer docs with more helpful setup information #571

Merged

Conversation

johncoleman83
Copy link
Contributor

@johncoleman83 johncoleman83 commented Sep 20, 2022

  • Adds More sections to the development docs.


Clone repository to: `$GOPATH/src/github.com/terraform-providers/terraform-provider-pagerduty`
Copy link
Contributor Author

@johncoleman83 johncoleman83 Sep 20, 2022

Choose a reason for hiding this comment

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

@@ -26,28 +26,78 @@ Enter the provider directory and build the provider
```sh
$ cd $GOPATH/src/github.com/PagerDuty/terraform-provider-pagerduty
$ make build
```

## Using the provider
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has simply been changed to "Usage" with some minor formatting changes.

Please refer to Terraform docs for [PagerDuty Provider](https://registry.terraform.io/providers/PagerDuty/pagerduty/latest/docs)
for examples on how to use the provider and detailed documentation about the Resources and Data Sources the provider has.

## Development
Copy link
Contributor Author

@johncoleman83 johncoleman83 Sep 20, 2022

Choose a reason for hiding this comment

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

Development has been renamed from "Developing the Provider" and expanded into 4 sections:

  • Setup Local Environment
  • Setup Local PagerDuty Provider
  • Run Dev Build with Local Terraform Module
  • Setup Local Logs

Copy link
Contributor

@imjaroiswebdev imjaroiswebdev left a comment

Choose a reason for hiding this comment

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

This is looking great @johncoleman83 thank you for this very needed contribution 💪🏽 😎

@imjaroiswebdev imjaroiswebdev merged commit 0aefa67 into PagerDuty:master Sep 20, 2022
@johncoleman83 johncoleman83 deleted the update-readme-developer-docs branch September 21, 2022 11:38
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