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.

Sign up for GitHub

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

Readme upgrade #338

Merged
merged 5 commits into from
May 25, 2022
Merged

Readme upgrade #338

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
823be8b
upgraded readme
pavangudiwada May 23, 2022
0a89fb9
upgraded readme Youtube URL
pavangudiwada May 23, 2022
fb39579
updated readme image and contact
pavangudiwada May 24, 2022
040ce03
Merge branch 'master' into readme-upgrade
aantn May 24, 2022
5b1b0e2
Merge branch 'master' into readme-upgrade
aantn May 25, 2022
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
120 changes: 103 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
# Robusta
Robusta is a troubleshooting and automations platform for Kubernetes. It streamlines everything that happens **after** you deploy your application. It is somewhat like Zapier/IFTTT for devops, with an emphasis on prebuilt useful automations and not just "build your own".
<div align="center">
<p>
<a href="https://home.robusta.dev/" target="_blank">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of reducing the height of the logo a little? It takes up a lot of sceenspace on desktop and pushes the content down below the fold.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reduced the size significantly.

<img src="./logos/Robusta_readme.png" alt="Robusta Logo">
</a>
</p>
<h2>Robusta</h2>
<h3>A troubleshooting and automations platform for Kubernetes</h3>
<a href="https://docs.robusta.dev/master/"><strong>Explore the docs »</strong></a>
<p>

![GitHub Workflow Status (event)](https://img.shields.io/github/workflow/status/robusta-dev/robusta/Test%20robusta%20with%20pytest?event=push&label=Build&style=flat-square)
![GitHub](https://img.shields.io/github/license/robusta-dev/robusta?color=orange&label=License&logoColor=Greed&style=flat-square)

[![twitter robusta](https://img.shields.io/twitter/follow/RobustaDev?logo=twitter&color=blue&label=@RobustaDev&style=flat-square)](https://twitter.com/RobustaDev)
[![slack robusta](https://img.shields.io/badge/Slack-Join-4A154B?style=flat-square&logo=slack&logoColor=white)](https://join.slack.com/t/robustacommunity/shared_invite/zt-10rkepc5s-FnXKvGjrBmiTkKdrgDr~wg)
<a href="https://www.linkedin.com/company/robusta-dev/"><img alt="LinkedIn" title="LinkedIn" src="https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white"/></a>
<a href="https://www.youtube.com/channel/UCeLrAOI3anJAfO3BrYVB62Q"><img alt="Youtube" title="Youtube" src="https://img.shields.io/youtube/channel/subscribers/UCeLrAOI3anJAfO3BrYVB62Q?color=%23ff0000&label=Robusta%20Dev&logo=youtube&logoColor=%23ff0000&style=flat-square"/></a>
</div>

<div id="top"></div>
<!-- TABLE OF CONTENTS -->
<details>
<summary><h3 style="display:inline;">Table of Contents</h3></summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
</li>
<li>
<a href="#use-cases">Use cases</a>
</li>
<li><a href="#examples">Examples</a></li>
<li><a href="#installing-robusta">Installing</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#license">License</a></li>
<li><a href="#stay-up-to-date">Stay up to date</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>

## About the project
Robusta streamlines everything that happens **after** you deploy your application. It is somewhat like Zapier/IFTTT for DevOps, with an emphasis on prebuilt useful automations and not just "build your own".

## Use cases

Expand All @@ -8,11 +50,8 @@ Robusta is a troubleshooting and automations platform for Kubernetes. It streaml
- [X] Auto-remediations - out of the box fixes for common alerts. Write your own in Python.
- [X] [Change tracking - track and audit every change to your Kubernetes cluster](http://home.robusta.dev/ui?from=github)

[Read the docs for more info](https://docs.robusta.dev/master/?from=github) or see screenshots and demos at [robusta.dev](http://robusta.dev/?from=github)
[Screenshots and demos »](http://robusta.dev/?from=github)

[![twitter robusta](https://img.shields.io/twitter/follow/RobustaDev?logo=twitter&style=for-the-badge)](https://twitter.com/RobustaDev)
[![slack robusta](https://img.shields.io/badge/Slack-Join-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/robustacommunity/shared_invite/zt-10rkepc5s-FnXKvGjrBmiTkKdrgDr~wg)
![GitHub Workflow Status (event)](https://img.shields.io/github/workflow/status/robusta-dev/robusta/Test%20robusta%20with%20pytest?event=push&style=for-the-badge)

## Examples

Expand Down Expand Up @@ -40,14 +79,11 @@ sinks:
robusta playbooks trigger python_debugger name=mypod namespace=default
```

[There are over 50 built-in automations.](https://docs.robusta.dev/master/catalog/actions/index.html)
[Over 50 built-in automations »](https://docs.robusta.dev/master/catalog/actions/index.html)

# Stay up to date
We add new features regularly. Stay up to date by watching us on GitHub.

![](./docs/images/star-repo.gif)
<p align="right">(<a href="#top">back to top</a>)</p>

# Installing Robusta
## Installing Robusta

1. Install our python cli:

Expand All @@ -66,11 +102,61 @@ helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo
helm install robusta robusta/robusta -f ./generated_values.yaml
```

Full instructions are in our [installation guide](https://docs.robusta.dev/master/installation.html).
[Detailed instructions »](https://docs.robusta.dev/master/installation.html)

<!-- <p align="right">(<a href="#top">back to top</a>)</p> -->

## Documentation
Interested? Learn more about Robusta

* [Architecture](https://docs.robusta.dev/master/architecture.html)
* [Upgrade and Uninstall](https://docs.robusta.dev/master/upgrade.html)
* [Configuration Guide](https://docs.robusta.dev/master/user-guide/configuration.html)
* [Triggers](https://docs.robusta.dev/master/catalog/triggers/index.html)

[Full documentation »](https://docs.robusta.dev/master/index.html)
<p align="right">(<a href="#top">back to top</a>)</p>

## Contributing
Any contribution is most welcome, fork the project, make changes and create a PR. We can't wait to review and merge your PR's!

* [Coding Conventions](https://docs.robusta.dev/master/developer-guide/platform/coding-conventions.html#formatting-and-coding-conventions)
* [Core platform contributions](https://docs.robusta.dev/master/developer-guide/platform/dev-setup.html)
* [Documentation contributions](https://docs.robusta.dev/master/developer-guide/platform/docs-contributions.html)
* [Issue/Feature](https://github.com/robusta-dev/robusta/issues)

## Contact

* Slack - [robustacommunity.slack.com](https://join.slack.com/t/robustacommunity/shared_invite/zt-10rkepc5s-FnXKvGjrBmiTkKdrgDr~wg)
* Twitter - [@RobustaDev](https://twitter.com/RobustaDev)
* LinkedIn - [robusta-dev](https://www.linkedin.com/company/robusta-dev/)
* Jobs - [jobs@robusta.dev ](mailto:jobs@robusta.dev)
* Commercial Support - [support@robusta.dev ](mailto:support@robusta.dev )
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe repace "Commercial Support" with "Email Support" - I want people to know that they can email us even if they're not a paying customer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes understood. Made the change


<p align="right">(<a href="#top">back to top</a>)</p>

## License
Robusta is distributed under the MIT License. See [LICENSE.md](https://github.com/robusta-dev/robusta/blob/master/LICENSE) for more information.


## Stay up to date
We add new features regularly. Stay up to date by watching us on GitHub.

![](./docs/images/star-repo.gif)


## Acknowledgments
Thank you to all of our contributors!

# Documentation
Interested? Read the [full documentation](https://docs.robusta.dev/master/index.html)
An additional thanks to all the open source projects we use. Especially:

# Contribute to Robusta
1. [Hikaru](https://hikaru.readthedocs.io/)
2. [Pydantic](https://pydantic-docs.helpmanual.io/)
3. [Typer](https://typer.tiangolo.com/tutorial/options/)
4. [Kubernetes Python library](https://github.com/kubernetes-client/python/)
5. [CairoSVG](https://github.com/Kozea/CairoSVG)
6. [...and all the other libraries we use](https://github.com/robusta-dev/robusta/network/dependencies)

Instructions to get [Robusta working locally for development](https://docs.robusta.dev/master/developer-guide/platform/index.html).
Each open source project is used in accordance with the relevant licenses.
Details can be found on the website for each project.
<p align="right">(<a href="#top">back to top</a>)</p>
Binary file added logos/Robusta_readme.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.