Kong / charts

Helm chart for Kong
Apache License 2.0
250 stars 480 forks source link

Migrate chart docs to docs.konghq.com #237

Closed mflendrich closed 2 years ago

shaneutt commented 3 years ago

After discussing with @mflendrich there's several considerations about the future of components we want to discuss as a team before we move forward on this. @Kong/team-k8s will need to have that conversation to unblock this.

mflendrich commented 3 years ago

I think that splitting this issue into 3 would unblock some of the work here:

  1. retire the "Kong for Kubernetes" section of docs.konghq.com
  2. migrate charts docs to docs.konghq.com
  3. migrate operator docs to docs.konghq.com

I think that (1) and (2) are ready to be worked on. (3) is uncertain because implementation of service-apis will likely have substantial overlap with Kong Operator. Depending on the path forward for service-apis, the upcoming operator for Gateways is likely to have significant feature overlap with Kong Operator.

rainest commented 3 years ago

Repurposing this issue for the chart doc migration, since it resides in the chart repo. The operator now has its own issue, and the follow-up task of de-duplicating content is https://github.com/Kong/team-k8s/issues/23

rainest commented 3 years ago

Base split layout proposed in the docs/split branch. It moves existing content under a docs directory and splits the README into several documents, with some changes in expectation of doc site stuff:

rainest commented 3 years ago

DOCS-1551 in internal Jira for coordination with the docs team.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

mflendrich commented 2 years ago

Closing as "won't fix" for now due to limited demand for this change.

@scseanchow, please let us know if this should be bumped in importance.