From ee7f100b334ebfef2ef480dc1b9fdce5458ae603 Mon Sep 17 00:00:00 2001 From: jakepage91 Date: Fri, 15 Sep 2023 14:40:17 +0100 Subject: [PATCH 1/2] added rounded images and videos also added GA tracker --- docs/community-support/contributing.mdx | 13 ++--- docs/community-support/events.mdx | 2 +- docs/community-support/faqs.mdx | 4 +- docs/configuration/cloud-providers/aws.mdx | 28 ++++------ docs/configuration/cloud-providers/civo.mdx | 12 ++--- docs/configuration/cloud-providers/k8s.mdx | 16 +++--- docs/getting-started/installation.mdx | 24 ++++----- docs/getting-started/introduction.mdx | 57 +++++++++++++-------- docs/getting-started/quickstart.mdx | 28 +++++----- docs/guides/dashboard.mdx | 13 ++--- docs/mint.json | 15 ++++-- 11 files changed, 99 insertions(+), 113 deletions(-) diff --git a/docs/community-support/contributing.mdx b/docs/community-support/contributing.mdx index edb3cde12..25c4095da 100644 --- a/docs/community-support/contributing.mdx +++ b/docs/community-support/contributing.mdx @@ -29,21 +29,16 @@ Once you’ve received review and approval, your commits are squashed, and your height:0, overflow:'hidden', }}> - --- -If you're in need of any assistance at any stage of your contributing journey please don't hesitate to reach out to anybody in the `#general` or `#feedback` discord channels, also let us know if you want to be added to the private `#contributors` channel too. Or directly to `@mlabouardy` or `@JakePage` who will always be happy to help. \ No newline at end of file +If you're in need of any assistance at any stage of your contributing journey please don't hesitate to reach out to anybody in the `#general` or `#feedback` discord channels, also let us know if you want to be added to the private `#contributors` channel too. Or directly to `@mlabouardy` or `@JakePage` who will always be happy to help. + + diff --git a/docs/community-support/events.mdx b/docs/community-support/events.mdx index 4ab23c57b..e52a85ed4 100644 --- a/docs/community-support/events.mdx +++ b/docs/community-support/events.mdx @@ -10,7 +10,7 @@ Whether you're keen on getting started as a contributor, seeking to understand m The event timings mentioned in the calendar are according to the **(GMT+01:00) Western European Time** timezone. Be sure to change it according to your **local timezone** while adding the event to the calendar! - + ## Multiple account EKS (Helm chart) installation @@ -354,10 +347,9 @@ Steps for a container to access the resources in multiple AWS accounts. We are working with two example clusters, ADMIN and DEV cluster. Solution diagram: -multi-account-graph + + + ### Create and IAM OIDC provider for your cluster diff --git a/docs/configuration/cloud-providers/civo.mdx b/docs/configuration/cloud-providers/civo.mdx index b40232fe1..34047578a 100644 --- a/docs/configuration/cloud-providers/civo.mdx +++ b/docs/configuration/cloud-providers/civo.mdx @@ -91,18 +91,12 @@ file="komiser.db height:0, overflow:'hidden', }}> - - \ No newline at end of file + + diff --git a/docs/configuration/cloud-providers/k8s.mdx b/docs/configuration/cloud-providers/k8s.mdx index 583d1c4f4..65e850379 100644 --- a/docs/configuration/cloud-providers/k8s.mdx +++ b/docs/configuration/cloud-providers/k8s.mdx @@ -73,7 +73,9 @@ Point your browser to `http://localhost:3000` ### You should see something like this! > In komiser v3.0.1 only `pods` and `services` are supported. More Kubernetes resources will be added shortly. -![Kubernetes-dashboard](/images/k8s-view.png) + + + ### Here's a video tutorial on how to integrate your Kubernetes cluster with Komiser: @@ -84,18 +86,12 @@ Point your browser to `http://localhost:3000` height:0, overflow:'hidden', }}> - - \ No newline at end of file + + diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx index a0212e836..2237b9d11 100644 --- a/docs/getting-started/installation.mdx +++ b/docs/getting-started/installation.mdx @@ -58,18 +58,12 @@ brew reinstall komiser height:0, overflow:'hidden', }}> - - \ No newline at end of file + + + diff --git a/docs/getting-started/introduction.mdx b/docs/getting-started/introduction.mdx index afd0bc277..16495465d 100644 --- a/docs/getting-started/introduction.mdx +++ b/docs/getting-started/introduction.mdx @@ -8,11 +8,15 @@ This section is a high-level overview of how the Komiser Documentation is struct The Komiser Documentation covers everything you need to know about Komiser. It made up of five main sections which are: -- [Introduction](/docs/Introduction/installation.md) -- [Cloud Providers](/docs/cloud-providers/aws) -- [Contributing](/docs/Contributing/contribute.md) -- [Guides](/docs/guides/overview) -- [FAQs](/docs/FAQ/faq.md) +[Introduction](/docs/Introduction/installation.md) + +[Cloud Providers](/docs/cloud-providers/aws) + +[Contributing](/docs/Contributing/contribute.md) + +[Guides](/docs/guides/overview) + +[FAQs](/docs/FAQ/faq.md) ## Introduction @@ -20,40 +24,51 @@ In the `introduction` section you will find the three pages below. Since Komiser Head over to the `Installation` page to get the download the Komiser CLI for your OS and architecture. The `What is Komiser?` page summarizes the goals and features of the Komiser project. -- [Community](/docs/Introduction/community.md) -- [Installation](/docs/Introduction/installation.md) -- [What is Komiser?](/docs/Introduction/what-is-komiser.md) +[Community](/docs/Introduction/community.md) + +[Installation](/docs/Introduction/installation.md) + +[What is Komiser?](/docs/Introduction/what-is-komiser.md) ## Cloud Providers Komiser supports multiple cloud providers and form of deployment. Follow the links below to get the installation steps for the each cloud provider: -- [AWS](/docs/cloud-providers/aws) -- [Azure](/docs/cloud-providers/azure) -- [Civo](/docs/cloud-providers/civo) -- [DigitalOcean](/docs/cloud-providers/digital-ocean) -- [Kubernetes](/docs/cloud-providers/kubernetes) -- [Linode](/docs/cloud-providers/linode) -- [MongoDB Atlas](/docs/cloud-providers/mongodb-atlas) -- [OCI](/docs/cloud-providers/oci) -- [Scaleway](/docs/cloud-providers/scaleway) -- [Tencent](/docs/cloud-providers/tencent) +[AWS](/docs/cloud-providers/aws) + +[Azure](/docs/cloud-providers/azure) + +[Civo](/docs/cloud-providers/civo) + +[DigitalOcean](/docs/cloud-providers/digital-ocean) + +[Kubernetes](/docs/cloud-providers/kubernetes) + +[Linode](/docs/cloud-providers/linode) + +[MongoDB Atlas](/docs/cloud-providers/mongodb-atlas) + +[OCI](/docs/cloud-providers/oci) + +[Scaleway](/docs/cloud-providers/scaleway) + +[Tencent](/docs/cloud-providers/tencent) ## Contributing Komiser is written in `Golang` and is `Elv2 licensed` - contributions are always welcome whether that means providing feedback, be it through GitHub, through the `#feedback` channel on our [Discord server](https://discord.tailwarden.com) or testing existing and new features. All of the relevant information below: -- [Contribute](/docs/Contributing/contribute.md) +[Contribute](/docs/Contributing/contribute.md) ## Guides We want to be able to give Komiser users the tips and guidance neccessary to be able to get the most value from the tool as quickly as possible. That's why we will be continously adding and updating informative guides and series in which try to relay valuable and actionable advice. -- [How to Komiser](/docs/guides/overview) +[How to Komiser](/docs/guides/overview) ## FAQs Find all the answers to all the Komiser related questions you might have. Feel free to reach out via the `#feedback` channel on [Discord](https://discord.tailwarden.com) to request the inclusion of additional questions. -- [FAQs](/docs/FAQ/faq.md) +[FAQs](/docs/FAQ/faq.md) diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx index 51a8562b2..c5daf0063 100644 --- a/docs/getting-started/quickstart.mdx +++ b/docs/getting-started/quickstart.mdx @@ -47,7 +47,9 @@ uri="postgres://postgres:komiser@localhost:5432/komiser?sslmode=disable" file = "komiser.db" ``` - The reason for this external data persistence is to improve the filtering, sorting and tagging management experience making it faster and smoother. It also serves as a standalone DB which you are free to query and visualize as you see fit. + +The reason for this external data persistence is to improve the filtering, sorting and tagging management experience making it faster and smoother. It also serves as a standalone DB which you are free to query and visualize as you see fit. + ### Example config.toml ``` @@ -121,20 +123,13 @@ docker run -v /local/path/to/config.toml:/etc/config/config.toml -v /local/path height:0, overflow:'hidden', }}> - + ## Self-hosted @@ -151,4 +146,5 @@ Head over to your cloud provider of choice to learn how to connect your Komiser * [MongoDB](/configuration/cloud-providers/mongodb-atlas) * [OCI](/configuration/cloud-providers/oci) * [Scaleway](/configuration/cloud-providers/scaleway) -* [Tencent](/configuration/cloud-providers/tencent) \ No newline at end of file +* [Tencent](/configuration/cloud-providers/tencent) + diff --git a/docs/guides/dashboard.mdx b/docs/guides/dashboard.mdx index f3d791325..0e407bfe1 100644 --- a/docs/guides/dashboard.mdx +++ b/docs/guides/dashboard.mdx @@ -13,7 +13,9 @@ To the left of the cloud map, you will find the `Resource manager`, where you ca Below, you will find the `Cost explorer`, which allows you to sort resources and compare costs on a monthly to yearly basis. You can also exclude resources from the cost comparison. -![Dashboard gif](/images/dashboard.png) + + + ### Check out the `dashboard` in the first part of the Komiser v3.0.3 video: @@ -24,18 +26,11 @@ Below, you will find the `Cost explorer`, which allows you to sort resources and height:0, overflow:'hidden', }}> - \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index fc03b572d..10e7a6c3d 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -7,8 +7,8 @@ }, "favicon": "/favicon.png", "colors": { - "primary": "#697372", - "light": "#FFFFFF", + "primary": "#008484", + "light": "#33CCCC", "dark": "#33CCCC", "background": { "dark": "#090F19" @@ -84,5 +84,12 @@ "linkedin": "https://www.linkedin.com/company/tailwarden", "youtube": "https://www.youtube.com/@tailwarden" }, - "backgroundImage": "/images/background-image.png" -} + + "backgroundImage": "/images/background-image.png", + + "analytics": { + "ga4": { + "measurementId": "G-PVLRSMWSFG" + } + } +} \ No newline at end of file From 6dbc32251894124614d2974ec597341e75c81c73 Mon Sep 17 00:00:00 2001 From: jakepage91 Date: Fri, 15 Sep 2023 14:52:52 +0100 Subject: [PATCH 2/2] updated anchor colors --- docs/mint.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mint.json b/docs/mint.json index 10e7a6c3d..c12638f95 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -14,8 +14,8 @@ "dark": "#090F19" }, "anchors": { - "from": "#FF7F57", - "to": "#9563FF" + "from": "#008484", + "to": "#33CCCC" } }, "topbarCtaButton": {