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

Update introduction.mdx #959

Merged
merged 7 commits into from
Sep 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 12 additions & 29 deletions docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,25 @@ title: Introduction
sidebar_label: Introduction
---

This section is a high-level overview of how the Komiser Documentation is structured. It will help you use the documentation more effectively by guiding you on where to look for specific information.

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)
## Introduction

[Contributing](/docs/Contributing/contribute.md)
Welcome to the Komiser Documentation, your comprehensive guide to harnessing the power of Komiser for efficient cloud resource management. Here's how our documentation is organized to help you quickly find the information you need.

[Guides](/docs/guides/overview)
## What is Komiser?

[FAQs](/docs/FAQ/faq.md)
Komiser is an open-source project that empowers users to optimize and manage their cloud resources efficiently. This documentation serves as a comprehensive guide to understanding and using [Komiser](/docs/Introduction/what-is-komiser.md) effectively.

## Introduction
## Community

In the `introduction` section you will find the three pages below. Since Komiser is an open-source project, we are fully aware that any OSS project is only as valuable as the community that surrounds it, that's why we want to make it as easy as possible for everyone to participate, you should be able to learn how to do that in the `Community` section.
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.
At Komiser, we believe that the strength of any open-source project lies in its community. Whether you're a developer, user, or enthusiast, you can contribute to the project's success. Learn how to get involved and join our thriving community in the [Community](https://docs.komiser.io/community-support/contributing) section.

[Community](/docs/Introduction/community.md)
## Installation

[Installation](/docs/Introduction/installation.md)

[What is Komiser?](/docs/Introduction/what-is-komiser.md)
To start using Komiser, you'll need to install the Komiser Command-Line Interface (CLI) tailored for your specific operating system and architecture. Visit the [Installation](https://docs.komiser.io/getting-started/installation) page for detailed instructions on how to download and set up Komiser on your system.

## 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:
Komiser is compatible with various cloud providers and deployment methods. Explore the installation steps for your preferred cloud provider from the list below:

[AWS](/docs/cloud-providers/aws)

Expand All @@ -57,18 +46,12 @@ Follow the links below to get the installation steps for the each cloud provider

## 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)
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. Find all the details on how to contribute in the [Contribute](https://docs.komiser.io/community-support/contributing) section.

## 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)
To help you make the most of Komiser, we provide a collection of informative guides and series. These guides offer valuable insights and actionable advice for optimizing your cloud resources with Komiser. Dive into the world of Komiser with our [How to Komiser](/docs/guides/overview) guide.

## 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)
Got questions about Komiser? Find answers to commonly asked questions in the [FAQs](/docs/FAQ/faq.md) section. If you have additional questions or suggestions, feel free to reach out through the `#feedback` channel on our [Discord](https://discord.tailwarden.com) server.