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

WIP - HELP - terraform provider kong documentation #1148

Closed

Conversation

kevholditch
Copy link

@kevholditch kevholditch commented Feb 11, 2019

Help

I must be missing something as my new tile is not appearing on the hub page. I'm not sure why, could someone please help

NOTE: Please read the CONTRIBUTING.md guidelines before submitting your patch,
and ensure you followed them all:

https://github.com/Kong/docs.konghq.com/blob/master/CONTRIBUTING.md

Summary

Adding deployment documentation for terraform provider kong

Full changelog

  • Added terraform provider kong documentation as per request

Issues resolved

Fix kevholditch/terraform-provider-kong#43

Checklist:

@netlify
Copy link

netlify bot commented Feb 11, 2019

Deploy preview for kongdocs ready!

Built with commit 095c7db

https://deploy-preview-1148--kongdocs.netlify.com

@kevholditch kevholditch force-pushed the add-terraform-provider-kong branch from 5813871 to 7e2f7f2 Compare February 11, 2019 08:32
@kevholditch kevholditch changed the title terraform provider kong documentation WIP - terraform provider kong documentation Feb 11, 2019
@kevholditch kevholditch changed the title WIP - terraform provider kong documentation WIP - HELP - terraform provider kong documentation Feb 11, 2019
@h3xar0n
Copy link
Contributor

h3xar0n commented Feb 22, 2019

Hi @kevholditch , I see it appearing locally, albeit without an image:

screen shot 2019-02-22 at 1 28 30 pm

I'm able to get there by visiting localhost:3000/hub. The issue may be that the Hub link in navigation is an absolute path that goes to the live doc site.

@levfishbluefish levfishbluefish self-assigned this Mar 4, 2019
@levfishbluefish
Copy link
Contributor

Hi @kevholditch - I've confirmed that it is working locally, you might be clicking the "hub" link in the header which will take you to the live hub page on docs.konghq.com

When running it locally you can see it at
http://localhost:3000/hub/
and
http://localhost:3000/hub/kevholditch/terraform-provider-kong/

Copy link
Contributor

@levfishbluefish levfishbluefish left a comment

Choose a reason for hiding this comment

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

Please add an icon.

If you do not have a custom icon you can copy the default_icon.png in _assets/icons/hub and name it kevholditch_terraform-provider-kong.png

@subnetmarco
Copy link
Member

Hi Guys, I think this should show up in the Installation Page rather than in the Kong Hub, under a Terraform icon.

@kevholditch
Copy link
Author

@levfishbluefish added default image or do we want to move this now? As per the comment from @subnetmarco? Think you could argue it either way between deployment and installation. Personally I think its more deployment as the provider doesn't help you install or run kong it simply configures an installation of kong that is already running.

The reason I put it in hub is that's where @coopr asked me to put it Happy to put it wherever is deemed best.

@levfishbluefish
Copy link
Contributor

@kevholditch lets go ahead and move this to the installation page

@hbagdi
Copy link
Member

hbagdi commented Mar 14, 2019

@subnetmarco? Think you could argue it either way between deployment and installation. Personally I think its more deployment as the provider doesn't help you install or run kong it simply configures an installation of kong that is already running.

I agree.
The provider helps us configure Kong and not deploy or install Kong using Terraform.
Most users will be confused because Terraform is widely used for deployment and installation.

Keep in mind that we have a Terraform module which can be used to deploy Kong as well: https://docs.konghq.com/hub/zillowgroup/kong-terraform/

I would suggest that we introduce a new category of Configuration, under which projects like these and other tools by the community, like Konga can be put.

Also, @kevholditch Thank you for building the Terraform provider for Kong! 🙇

@levfishbluefish
Copy link
Contributor

@subnetmarco? Think you could argue it either way between deployment and installation. Personally I think its more deployment as the provider doesn't help you install or run kong it simply configures an installation of kong that is already running.

I agree.
The provider helps us configure Kong and not deploy or install Kong using Terraform.
Most users will be confused because Terraform is widely used for deployment and installation.

Keep in mind that we have a Terraform module which can be used to deploy Kong as well: https://docs.konghq.com/hub/zillowgroup/kong-terraform/

I would suggest that we introduce a new category of Configuration, under which projects like these and other tools by the community, like Konga can be put.

Also, @kevholditch Thank you for building the Terraform provider for Kong! 🙇

@subnetmarco I'll give you the final say

@levfishbluefish levfishbluefish removed their assignment Mar 27, 2019
@subnetmarco
Copy link
Member

We should have a "Terraform" icon in the installation page, and within that page we can have two sections: "Installing with Terraform" and "Configuring with Terraform". It's more likely for a user trying to use Kong via Terraform to do so via the Installation page and Terraform link, rather than scrolling the Hub. In fact, I would like to move all the "Deployments" in the Hub to the Installation page in a specific "Community Contributed" section.

In the meanwhile, we can make that clear by adding a note to the Terraform page, but still have it visible in the installation page.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@Bradamant3
Copy link
Contributor

Bradamant3 commented Feb 25, 2021

Unresolved bikeshedding around an unclear contribution. We can reopen if someone wants to not only propose but implement a workable solution.

@Bradamant3 Bradamant3 closed this Feb 25, 2021
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.

List on Kong Hub and then announce on Kong Nation
7 participants