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

Terraform Provider Development Program #1

Closed
cgriggs01 opened this issue Aug 1, 2018 · 5 comments
Closed

Terraform Provider Development Program #1

cgriggs01 opened this issue Aug 1, 2018 · 5 comments

Comments

@cgriggs01
Copy link

Hi @jakewan,

My name is Chris Griggs, and I'll be your main contact with HashiCorp throughout the review and release phase of this Terraform provider.

From your form submission I understand that this first release will be just the dns_app resource and then you'll be continuing the development after release. That sounds like a great plan!

I was able to run the acceptance tests without issue and they all passed successfully, 👍 these acceptance test are critical to this program and we'll need to verify that they pass at the end of each review iteration. As well, after the official release of the provider, these test will run nightly in a TeamCity environment along with the rest of the Terraform providers.

The only other item to address at this time is the providers website documentation, once that has been written, we can begin the review process.

If you have any questions please feel free ask here or reach out to me at [email protected].

Best,
Chris

@jakewan
Copy link
Contributor

jakewan commented Aug 2, 2018

Hi Chris,

It's nice to meet you.

This all sounds great, and it so happens that website documentation is right where I'm stuck in getting the Travis CI builds to pass.

https://travis-ci.org/cedexis/terraform-provider-citrixitm/builds/411088299

I delved into the problem by trying to get the make test-website task to succeed locally and exploring the Docker container interactively.

To get Middleman to see the documentation source files, I needed to add two symlinks to the terrform-website repo:

  1. One in content/source/layouts:
ln -s ../../../ext/providers/citrixitm/website/citrixitm.erb citrixitm.erb
  1. And one in content/source/docs/providers
ln -s ../../../../ext/providers/citrixitm/website/docs citrixitm

This much alone should enable me to iteratively build up the provider documentation locally, and if I understand correctly, I should merge all documentation work to a branch named stable-website, which is based off of master. Am I going about this the right way?

As for the Travis CI builds, those won't begin passing until those symlinks are added to the real terraform-website repo. Will I be able to issue a pull request adding those at some point in the process? I already tried to push a feature branch, but as expected, I didn't have the necessary permissions because I'm not a contributor.

$ git push -u origin citrixitm-add-links 
remote: Permission to hashicorp/terraform-website.git denied to jakewan.
fatal: unable to access 'https://github.com/hashicorp/terraform-website/': The requested URL returned error: 403

In any case, thanks for helping me through all this. I'm really looking forward to the process.

Jacob

cc @cgriggs01

@cgriggs01
Copy link
Author

Jacob,

Glad to hear your excitement regard the provider, we look forward to officially integrating Terraform with the Citrix ITM platform.

You are on the right track for the website documentation, while the make test-website task is should only function with a provider that has already been merged into the TF ecosystem. While you can run the Middleman to deploy the website to docker with the make website task.

Yes, there must be a separate branch name stable-website where the website documentation is sourced from.

As for the PRs need to merge the provider links and documentation, you are not required to make those. My team will make the necessary updates and migrate the providers repository to the github.com/terraform-providers Github organization.

@cgriggs01
Copy link
Author

Hi @jakewan,

Hope things are going well. It appears that you've completed the website docs. That is great, I will start testing and review the provider again!

Looking forward to releasing this provider!

@jakewan
Copy link
Contributor

jakewan commented Nov 1, 2018

Hi @cgriggs01,

Thanks for picking up on this! Sorry, I've had some family things to deal with and have been away a lot in the last few months. Yes, proceeding with the review at this point would be great. I had been holding back in order to fix a bug in one particular scenario: how the provider behaves when a user deletes a Terraform-managed resource through our Web Portal (or some other way outside of Terraform). But I can fix that separately from your review of what exists today.

Jacob

@cgriggs01
Copy link
Author

cgriggs01 commented Mar 12, 2019

Hey Team,

I created a new Issue #14 for the second more technical review.

I'll be closing this issue now

Thanks,
Chris

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

No branches or pull requests

2 participants