diff --git a/.gitbook.yaml b/.gitbook.yaml index c6deff0c3..9324eea44 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -1,6 +1,7 @@ root: ./ structure: + readme: LANDING.md summary: SUMMARY.md redirects: diff --git a/.gitbook/assets/card-example1.png b/.gitbook/assets/card-example1.png new file mode 100644 index 000000000..14b4f9741 Binary files /dev/null and b/.gitbook/assets/card-example1.png differ diff --git a/.gitbook/assets/card-example2.png b/.gitbook/assets/card-example2.png new file mode 100644 index 000000000..415bb3c3d Binary files /dev/null and b/.gitbook/assets/card-example2.png differ diff --git a/.gitbook/assets/card-example3.png b/.gitbook/assets/card-example3.png new file mode 100644 index 000000000..94678bc0f Binary files /dev/null and b/.gitbook/assets/card-example3.png differ diff --git a/.github/find-unreferenced-images.sh b/.github/find-unreferenced-images.sh new file mode 100755 index 000000000..cf4111c7a --- /dev/null +++ b/.github/find-unreferenced-images.sh @@ -0,0 +1,12 @@ +# Find all images in the .gitbook/assets and images directories +find .gitbook/assets -type f \( -iname "*.jpg" -o -iname "*.png" -o -iname "*.gif" \) > images_list.txt +find images -type f \( -iname "*.jpg" -o -iname "*.png" -o -iname "*.gif" \) >> images_list.txt + + +# Check each image for references in the site files and identify unreferenced images +while read image; do + image_name=$(basename "$image") + if ! grep -r --include=\*.md "$image_name" . > /dev/null; then + echo "$image_name is not referenced in any file." + fi +done < images_list.txt \ No newline at end of file diff --git a/LANDING.md b/LANDING.md new file mode 100644 index 000000000..01f9772df --- /dev/null +++ b/LANDING.md @@ -0,0 +1,7 @@ +# Welcome + +![](/images/kubecost_logo_horizontal_white.jpg) + +Welcome to the official Kubecost documentation. Choose from one of the cards available or browse the full documentation from the sidebar. + +
Install and ConfigureLearn how to install and configure Kubecost.install-and-configure/install/install.mdcard-example1.png
Using KubecostLearn how to use all of Kubecost's functionality.using-kubecost/navigating-the-kubecost-ui/README.mdcard-example2.png
APIsInspect and learn how to use Kubecost's APIs.apis/apis-overview.mdcard-example3.png
\ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index 03f888459..287197a47 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [Welcome to the Docs!](README.md) +* [Kubecost Documentation](LANDING.md) ## Install and Configure diff --git a/images/kubecost_logo_horizontal_white.jpg b/images/kubecost_logo_horizontal_white.jpg new file mode 100644 index 000000000..54c189c86 Binary files /dev/null and b/images/kubecost_logo_horizontal_white.jpg differ diff --git a/troubleshooting/creating-a-support-ticket.md b/troubleshooting/creating-a-support-ticket.md index 3d08a9346..0fc5aa5bd 100644 --- a/troubleshooting/creating-a-support-ticket.md +++ b/troubleshooting/creating-a-support-ticket.md @@ -1,6 +1,6 @@ # Creating a Kubecost Support Ticket in Slack -The Kubecost support team offers several channels for creating support tickets. This document will show how to create a new support ticket using Slack, which can be used in the public #support channel, or a private channel created for your orginization. Kubecost's Slack is publicly available and can be joined by following [this link](https://kubecost.com/join-slack). +The Kubecost support team offers several channels for creating support tickets. This document will show how to create a new support ticket using Slack, which can be used in the public #support channel, or a private channel created for your organization. Kubecost's Slack is publicly available and can be joined by following [this link](https://kubecost.com/join-slack). 1. Create a new Slack message thread in the Slack channel.