Merge pull request #13 from deepgram/brent-george/fix-helm-repo-link

Update README correct links

.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          token: "${{ secrets.DGPAT }}"
+          token: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}"
 
       - name: Configure Git
         run: |
@@ -26,7 +26,7 @@ jobs:
       - name: Install Helm
         uses: azure/setup-helm@v4
         env:
-          GITHUB_TOKEN: "${{ secrets.DGPAT }}"
+          GITHUB_TOKEN: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}"
 
       - name: Add NVIDIA Helm chart repository
         run: |
@@ -36,4 +36,4 @@ jobs:
       - name: Run chart-releaser
         uses: helm/[email protected]
         env:
-          CR_TOKEN: "${{ secrets.DGPAT }}"
+          CR_TOKEN: "${{ secrets.GH_SELFHOSTEDRESOURCES_RW }}"

README.md

@@ -13,10 +13,13 @@ You can learn more about the Deepgram API at [developers.deepgram.com](https://d
 
 ## Getting Help
 
-We love to hear from you so if you have questions, comments or find a bug in the
-charts, let us know! You can either:
-
-- [Open an issue in this repository](https://github.com/deepgram/helm-charts/issues/new/choose)
-- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
-- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
+We love to hear from you so if you have questions, comments or find a bug in this repo, let us know!
+
+- If you have a Premium or VIP Support Plan with Deepgram you can find details and links to contact us for support on your [Console dashboard](https://console.deepgram.com).
+- If you're interested in learning more about self-hosting Deepgram products, [contact us here](https://deepgram.com/contact-us)!
+- If you have a specific bug or feature request for these resources, [you can open an issue in this repo](https://github.com/deepgram/self-hosted-resources/issues/new/choose).
+- The [Deepgram documentation](https://developers.deepgram.com) and [Deepgram Help Center](https://deepgram.gitbook.io/help-center) have answers to many common questions.
+- Deepgram also has a developer community!
+  - [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
+  - [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
 

charts/deepgram-self-hosted/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: deepgram-self-hosted
 type: application
-version: 0.1.0-alpha
+version: 0.1.1-alpha
 appVersion: "release-240528"
 description: A Helm chart for running Deepgram services in a self-hosted environment
 home: "https://developers.deepgram.com/docs/self-hosted-introduction"

charts/deepgram-self-hosted/README.md

@@ -1,6 +1,6 @@
 # deepgram-self-hosted
 
-![Version: 0.1.0-alpha](https://img.shields.io/badge/Version-0.1.0--alpha-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: release-240528](https://img.shields.io/badge/AppVersion-release--240528-informational?style=flat-square) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/deepgram-self-hosted)](https://artifacthub.io/packages/search?repo=deepgram-self-hosted)
+![Version: 0.1.1-alpha](https://img.shields.io/badge/Version-0.1.1--alpha-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: release-240528](https://img.shields.io/badge/AppVersion-release--240528-informational?style=flat-square) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/deepgram-self-hosted)](https://artifacthub.io/packages/search?repo=deepgram-self-hosted)
 
 A Helm chart for running Deepgram services in a self-hosted environment
 
@@ -23,7 +23,7 @@ Kubernetes: `>=1.27.0-0`
 ## Get Repository Info
 
 ```bash
-helm repo add deepgram https://deepgram.github.io/helm-charts
+helm repo add deepgram https://deepgram.github.io/self-hosted-resources
 helm repo update
 ```
 
@@ -98,7 +98,11 @@ The Deepgram Helm chart takes references to two existing secrets - one containin
 
 Consult the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/) for best practices on configuring Secrets for use in your cluster.
 
-## Troubleshooting
+## Getting Help
+
+See the [Getting Help](../../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues.
+
+### Troubleshooting
 
 If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps:
 
@@ -123,7 +127,7 @@ If you encounter issues while deploying or using Deepgram, consider the followin
        ```bash
        helm get values [RELEASE_NAME] > my-deployed-values.yaml
        ```
-   - Reach out to the Deepgram support team, providing the collected diagnostic information for assistance.
+   - Provide the collected diagnostic information to Deepgram for assistance.
 
 ## Values
 

charts/deepgram-self-hosted/README.md.gotmpl

@@ -16,7 +16,7 @@
 ## Get Repository Info
 
 ```bash
-helm repo add deepgram https://deepgram.github.io/helm-charts
+helm repo add deepgram https://deepgram.github.io/self-hosted-resources
 helm repo update
 ```
 
@@ -91,7 +91,11 @@ The Deepgram Helm chart takes references to two existing secrets - one containin
 
 Consult the [official Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/) for best practices on configuring Secrets for use in your cluster.
 
-## Troubleshooting
+## Getting Help
+
+See the [Getting Help](../../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues.
+
+### Troubleshooting
 
 If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps:
 
@@ -116,7 +120,7 @@ If you encounter issues while deploying or using Deepgram, consider the followin
        ```bash
        helm get values [RELEASE_NAME] > my-deployed-values.yaml
        ```
-   - Reach out to the Deepgram support team, providing the collected diagnostic information for assistance.
+   - Provide the collected diagnostic information to Deepgram for assistance.
 
 {{ template "chart.valuesSection" . }}
 

charts/deepgram-self-hosted/samples/aws/license-proxy/values.yaml

@@ -1,5 +1,4 @@
-# See the Chart [README](https://github.com/deepgram/helm-charts) or
-#   [`values.yaml`](https://github.com/deepgram/helm-charts/blob/main/values.yaml)
+# See the Chart [README](https://github.com/deepgram/self-hosted-resources/blob/main/charts/deepgram-self-hosted#values)
 #   for documentation on all available options.
 
 global:

charts/deepgram-self-hosted/samples/gcp/license-proxy/values.yaml

@@ -1,5 +1,4 @@
-# See the Chart [README](https://github.com/deepgram/helm-charts) or
-#   [`values.yaml`](https://github.com/deepgram/helm-charts/blob/main/values.yaml)
+# See the Chart [README](https://github.com/deepgram/self-hosted-resources/blob/main/charts/deepgram-self-hosted#values)
 #   for documentation on all available options.
 
 global:

docker/README.md

@@ -22,3 +22,35 @@ There are several [Docker Compose](https://docs.docker.com/compose/) templates f
     $ export DEEPGRAM_API_KEY=<your api key here>
     ```
 4. Finish the walkthrough documentation by completing the [Deploy Deepgram Services](https://developers.deepgram.com/docs/deploy-deepgram-services) guide.
+
+## Getting Help
+
+See the [Getting Help](../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues.
+
+### Troubleshooting
+
+If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps:
+
+1. Check the pod status and logs:
+   - Use `docker ps` to check the status of the Deepgram containers.
+   - Use `docker logs <container-id>` to view the logs of a specific container.
+   - Use `docker inspect <container-id>` to view the configuration and status of a specific container.
+
+2. Verify resource availability:
+   - Ensure that the host machine has sufficient CPU, memory, and storage resources to accommodate the Deepgram components.
+   - Check for any resource constraints or limits imposed by your Docker Compose file or `docker run` command.
+
+3. Check the network connectivity:
+   - Verify that the Deepgram components can communicate with each other and with the Deepgram license server (license.deepgram.com).
+   - Check the network policies and firewall rules to ensure that the necessary ports and protocols are allowed.
+
+4. Collect diagnostic information:
+   - Gather relevant logs and metrics.
+   - Collect your existing configuration files:
+     - `api.toml`
+     - `engine.toml`
+     - `docker-compose.yml`
+     - `license-proxy.toml`, if applicable
+   - Provide the collected diagnostic information to Deepgram for assistance.
+
+

podman/README.md

@@ -22,3 +22,35 @@ There are several [Podman Compose](https://github.com/containers/podman-compose)
     $ export DEEPGRAM_API_KEY=<your api key here>
     ```
 4. Finish the walkthrough documentation by completing the [Deploy Deepgram Services](https://developers.deeps](https://developers.deepgram.com/docs/deploy-deepgram-services) guide.
+
+## Getting Help
+
+See the [Getting Help](../README.md#getting-help) section in the root of this repository for a list of resources to help you troubleshoot and resolve issues.
+
+### Troubleshooting
+
+If you encounter issues while deploying or using Deepgram, consider the following troubleshooting steps:
+
+1. Check the pod status and logs:
+   - Use `podman ps` to check the status of the Deepgram containers.
+   - Use `podman logs <container-id>` to view the logs of a specific container.
+   - Use `podman inspect <container-id>` to view the configuration and status of a specific container.
+
+2. Verify resource availability:
+   - Ensure that the host machine has sufficient CPU, memory, and storage resources to accommodate the Deepgram components.
+   - Check for any resource constraints or limits imposed by your Podman Compose file or `podman run` command.
+
+3. Check the network connectivity:
+   - Verify that the Deepgram components can communicate with each other and with the Deepgram license server (license.deepgram.com).
+   - Check the network policies and firewall rules to ensure that the necessary ports and protocols are allowed.
+
+4. Collect diagnostic information:
+   - Gather relevant logs and metrics.
+   - Collect your existing configuration files:
+     - `api.toml`
+     - `engine.toml`
+     - `podman-compose.yml`
+     - `license-proxy.toml`, if applicable
+   - Provide the collected diagnostic information to Deepgram for assistance.
+
+