Skip to content

Remove ASCII art from chart README.md documents #1174

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

Merged
merged 3 commits into from
Oct 9, 2018
Merged

Remove ASCII art from chart README.md documents #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7af85c3
Remove ASCII art from chart README.md documents
Oct 8, 2018
7d2527f
Add further changes
Oct 8, 2018
b17602f
Change the heading size
Oct 8, 2018
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
15 changes: 1 addition & 14 deletions components/configurations-generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,4 @@
```
____ __ _ _ _
/ ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ ___
| | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \/ __|
| |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | \__ \
\____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_|___/
|___/
____ _
/ ___| ___ _ __ ___ _ __ __ _| |_ ___ _ __
| | _ / _ \ '_ \ / _ \ '__/ _` | __/ _ \| '__|
| |_| | __/ | | | __/ | | (_| | || (_) | |
\____|\___|_| |_|\___|_| \__,_|\__\___/|_|

```
# Configurations Generator

## Overview

Expand Down
2 changes: 2 additions & 0 deletions components/environments/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Environments

## Overview

This controller injects limit ranges, resource quotas, and default roles into each Namespace that you create.
Expand Down
12 changes: 3 additions & 9 deletions components/event-bus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
```
______ _ ____
| ____| | | | _ \
| |____ _____ _ __ | |_ | |_) |_ _ ___
| __\ \ / / _ \ '_ \| __| | _ <| | | / __|
| |___\ V / __/ | | | |_ | |_) | |_| \__ \
|______\_/ \___|_| |_|\__| |____/ \__,_|___/
```
# Event Bus

## Overview
The Event Bus enables Kyma to integrate with various other external solutions. The integration uses the `publish-subscribe` messaging pattern that allows Kyma to receive business Events from different solutions, enrich the events, and trigger business flows using lambdas or services defined in Kyma. See the [Event Bus documentation](https://github.com/kyma-project/kyma/tree/master/docs/event-bus/docs).

The Event Bus enables Kyma to integrate with various other external solutions. The integration uses the `publish-subscribe` messaging pattern that allows Kyma to receive business Events from different solutions, enrich the events, and trigger business flows using lambdas or services defined in Kyma. See the [Event Bus documentation](https://github.com/kyma-project/kyma/tree/master/docs/event-bus/docs).

## Docker Images

Currently, Event Bus makes the following three Docker images available to the `kyma core` Helm chart:

- event-bus-publish
Expand Down
5 changes: 4 additions & 1 deletion components/helm-broker/cmd/targz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# TARGZ

## Overview

TARGZ converts all bundles stored in <input_directory> and store them as a 'tar.gz' files inside <output_directory>

## Usage
```
targz <input_directory> <output_directory>"
```
```
5 changes: 3 additions & 2 deletions components/installer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Installer

## Overview

Installer is a tool for installing all Kyma components.
The project is based on the Kubernetes operator pattern. It tracks changes of the `Installation` type instance of the custom resource. It also installs, uninstalls, and updates Kyma accordingly.

Expand Down Expand Up @@ -127,6 +129,5 @@ $ ../../installation/scripts/manage-component.sh azure-broker true

## Static overrides for cluster installations

You can define cluster-specific overrides for each root chart. In the cluster deployment scenario, the installer reads the `cluster.yaml` file in each root chart and appends its content to the overrides applied during the
You can define cluster-specific overrides for each root chart. In the cluster deployment scenario, the installer reads the `cluster.yaml` file in each root chart and appends its content to the overrides applied during the
Helm installation.

9 changes: 1 addition & 8 deletions components/istio-webhook/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
```
___ _ _ __ __ _ _ _
|_ _|___| |_(_) ___ \ \ / /__| |__ | |__ ___ ___ | | __
| |/ __| __| |/ _ \ \ \ /\ / / _ \ '_ \| '_ \ / _ \ / _ \| |/ /
| |\__ \ |_| | (_) | \ V V / __/ |_) | | | | (_) | (_) | <
|___|___/\__|_|\___/ \_/\_/ \___|_.__/|_| |_|\___/ \___/|_|\_\
```

# Istio Webhook

## Overview

Expand Down
9 changes: 1 addition & 8 deletions components/remote-environment-controller/charts/remote-environments/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
```
_____ _ ______ _ _
| __ \ | | | ____| (_) | |
| |__) |___ _ __ ___ ___ | |_ ___ | |__ _ ____ ___ _ __ ___ _ __ _ __ ___ ___ _ __ | |_ ___
| _ // _ \ '_ ` _ \ / _ \| __/ _ \ | __| | '_ \ \ / / | '__/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __/ __|
| | \ \ __/ | | | | | (_) | || __/ | |____| | | \ V /| | | | (_) | | | | | | | | | __/ | | | |_\__ \
|_| \_\___|_| |_| |_|\___/ \__\___| |______|_| |_|\_/ |_|_| \___/|_| |_|_| |_| |_|\___|_| |_|\__|___/
```
# Remote Environments

## Overview

Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Documentation

# Overview

The `docs` folder contains end-to-end documentation on Kyma and its components.

Start with the overarching [Kyma](kyma/docs) documentation where you can find the general information on Kyma and the Getting Started guides. Then, read about the product in more detail:
Expand Down
12 changes: 2 additions & 10 deletions resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
```
_____
| __ \
| |__) |___ ___ ___ _ _ _ __ ___ ___ ___
| _ // _ \/ __|/ _ \| | | | '__/ __/ _ \/ __|
| | \ \ __/\__ \ (_) | |_| | | | (_| __/\__ \
|_| \_\___||___/\___/ \__,_|_| \___\___||___/
# Resources

```

## Overview
## Overview

Resources are all components in Kyma that are available for local and cluster installation. You can find more details about each component in the corresponding README.md files.

Expand Down
11 changes: 1 addition & 10 deletions resources/cluster-essentials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@

```
_____ _ _ ______ _ _ _
/ ____| | | | | ____| | | (_) | |
| | | |_ _ ___| |_ ___ _ __ | |__ ___ ___ ___ _ __ | |_ _ __ _| |___
| | | | | | / __| __/ _ \ '__| | __| / __/ __|/ _ \ '_ \| __| |/ _` | / __|
| |____| | |_| \__ \ || __/ | | |____\__ \__ \ __/ | | | |_| | (_| | \__ \
\_____|_|\__,_|___/\__\___|_| |______|___/___/\___|_| |_|\__|_|\__,_|_|___/

```
# Cluster Essentials

## Overview

Expand Down
12 changes: 2 additions & 10 deletions resources/cluster-essentials/charts/pod-preset/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
```
_____ _ _____ _
| __ \ | | | __ \ | |
| |__) |__ __| | | |__) | __ ___ ___ ___| |_
| ___/ _ \ / _` | | ___/ '__/ _ \/ __|/ _ \ __|
| | | (_) | (_| | | | | | | __/\__ \ __/ |_
|_| \___/ \__,_| |_| |_| \___||___/\___|\__|

```
# Pod Preset

## Overview

Expand All @@ -18,7 +10,7 @@ Using a PodPreset, you do not have to provide all information for every Pod.
This Helm chart installs the admission controller extracted from the main Kubernetes repository. Find the source code [here](https://github.com/jpeeler/podpreset-crd).
This Helm chart is required because the managed cluster does not enable the core Kubernetes admission controller for PodPreset since it is in the alpha state.

This chart also provides the controller-manager which is responsible for restarting the Deployments whenever the PodPreset changes.
This chart also provides the controller-manager which is responsible for restarting the Deployments whenever the PodPreset changes.
This functionality is not present in the main Kubernetes implementation and by default is disabled in this Helm chart. If you want to enable the controller-manager, set the **controller.enabled** parameter to `true` in the [values.yaml](./values.yaml) file.

### Images
Expand Down
10 changes: 1 addition & 9 deletions resources/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
```
_____
/ ____|
| | ___ _ __ ___
| | / _ \| '__/ _ \
| |___| (_) | | | __/
\_____\___/|_| \___|

```
# Core

## Overview

Expand Down
13 changes: 2 additions & 11 deletions resources/core/charts/api-controller/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@

```
_____ _____ _____ _ _ _
/\ | __ \_ _| / ____| | | | | |
/ \ | |__) || |______| | ___ _ __ | |_ _ __ ___ | | | ___ _ __
/ /\ \ | ___/ | |______| | / _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|
/ ____ \| | _| |_ | |___| (_) | | | | |_| | | (_) | | | __/ |
/_/ \_\_| |_____| \_____\___/|_| |_|\__|_| \___/|_|_|\___|_|


```
# API-Controller

## Overview

API-Controller is a component allowing to expose a service through the Kyma Console. Manages Ingresses and JWT rules.
12 changes: 1 addition & 11 deletions resources/core/charts/apiserver-proxy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
```
_ __ _ _ _____ _____ _____ _____
| |/ / | | | | /\ | __ \_ _| / ____| | __ \
| ' /_ _| |__ ___ _ __ _ __ ___| |_ ___ ___ / \ | |__) || | | (___ ___ _ ____ _____ _ __ | |__) | __ _____ ___ _
| <| | | | '_ \ / _ \ '__| '_ \ / _ \ __/ _ \/ __| / /\ \ | ___/ | | \___ \ / _ \ '__\ \ / / _ \ '__| | ___/ '__/ _ \ \/ / | | |
| . \ |_| | |_) | __/ | | | | | __/ || __/\__ \ / ____ \| | _| |_ ____) | __/ | \ V / __/ | | | | | | (_) > <| |_| |
|_|\_\__,_|_.__/ \___|_| |_| |_|\___|\__\___||___/ /_/ \_\_| |_____| |_____/ \___|_| \_/ \___|_| |_| |_| \___/_/\_\\__, |
__/ |
|___/
```
# API Server Proxy

## Overview

This API Server Proxy is a transparent proxy for the Kubernetes API based on [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy). It is exposed for the external communication.


## Details

Kyma requires all APIs, including those provided by the Kubernetes API server, to be exposed in a consistent manner through Istio.
Expand Down
11 changes: 1 addition & 10 deletions resources/core/charts/application-connector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
```
_ _ _ _ _____ _
/\ | (_) | | (_) / ____| | |
/ \ _ __ _ __ | |_ ___ __ _| |_ _ ___ _ __ | | ___ _ __ _ __ ___ ___| |_ ___ _ __
/ /\ \ | '_ \| '_ \| | |/ __/ _` | __| |/ _ \| '_ \ | | / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__|
/ ____ \| |_) | |_) | | | (_| (_| | |_| | (_) | | | | | |___| (_) | | | | | | | __/ (__| || (_) | |
/_/ \_\ .__/| .__/|_|_|\___\__,_|\__|_|\___/|_| |_| \_____\___/|_| |_|_| |_|\___|\___|\__\___/|_|
| | | |
|_| |_|
```
# Application Connector

## Overview

Expand Down
12 changes: 1 addition & 11 deletions resources/core/charts/application-connector/charts/connector-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
```
____ _
/ ___|___ _ __ _ __ ___ ___| |_ ___ _ __
| | / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__|
| |__| (_) | | | | | | | __/ (__| || (_) | |
\____\___/|_| |_|_| |_|\___|\___|\__\___/|_|
/ ___| ___ _ ____ _(_) ___ ___
\___ \ / _ \ '__\ \ / / |/ __/ _ \
___) | __/ | \ V /| | (_| __/
|____/ \___|_| \_/ |_|\___\___|
```
# Connector Service

## Overview
The Connector Service is responsible for generating and sending back client certificates based on Certificate Signing Request (CSR).
Expand Down
11 changes: 1 addition & 10 deletions resources/core/charts/azure-broker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,11 @@
```
____ _
/\ | _ \ | |
/ \ _____ _ _ __ ___ | |_) |_ __ ___ | | _____ _ __
/ /\ \ |_ / | | | '__/ _ \ | _ <| '__/ _ \| |/ / _ \ '__|
/ ____ \ / /| |_| | | | __/ | |_) | | | (_) | < __/ |
/_/ \_\/___|\__,_|_| \___| |____/|_| \___/|_|\_\___|_|

```
# Azure Broker

## Overview

The [Azure Broker](https://github.com/Azure/open-service-broker-azure) is an open source, [Open Service Broker](https://www.openservicebrokerapi.org/)-compatible
API server that provisions managed services in the Microsoft Azure public cloud.
This chart is based on the [Azure Open Service Broker](https://github.com/Azure/open-service-broker-azure/tree/master/contrib/k8s/charts/open-service-broker-azure) chart and runs in Kyma.


## Details

The [azure-broker-basic-auth](templates/azure-broker-basic-auth.yaml) file contains the user name and password for basic authentication used by the Service Catalog.
Expand Down
9 changes: 1 addition & 8 deletions resources/core/charts/azure-broker/charts/redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
```
_____ _ _
| __ \ | (_)
| |__) |___ __| |_ ___
| _ // _ \/ _` | / __|
| | \ \ __/ (_| | \__ \
|_| \_\___|\__,_|_|___/
```
# Redis

## Overview

Expand Down
10 changes: 1 addition & 9 deletions resources/core/charts/cluster-users/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
```
_____ _ _ _ _
/ ____| | | | | | | |
| | | |_ _ ___| |_ ___ _ __ | | | |___ ___ _ __ ___
| | | | | | / __| __/ _ \ '__| | | | / __|/ _ \ '__/ __|
| |____| | |_| \__ \ || __/ | | |__| \__ \ __/ | \__ \
\_____|_|\__,_|___/\__\___|_| \____/|___/\___|_| |___/

```
# Cluster Users

## Overview

Expand Down
15 changes: 1 addition & 14 deletions resources/core/charts/configurations-generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,4 @@
```
____ __ _ _ _
/ ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ ___
| | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \/ __|
| |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | \__ \
\____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_|___/
|___/
____ _
/ ___| ___ _ __ ___ _ __ __ _| |_ ___ _ __
| | _ / _ \ '_ \ / _ \ '__/ _` | __/ _ \| '__|
| |_| | __/ | | | __/ | | (_| | || (_) | |
\____|\___|_| |_|\___|_| \__,_|\__\___/|_|

```
# Configurations Generator

## Overview

Expand Down
15 changes: 4 additions & 11 deletions resources/core/charts/console/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
```
_____ _
/ ____| | |
| | ___ _ __ ___ ___ | | ___
| | / _ \| '_ \/ __|/ _ \| |/ _ \
| |___| (_) | | | \__ \ (_) | | __/
\_____\___/|_| |_|___/\___/|_|\___|
# Console

```
## Overview

The Console is a web-based UI for Kyma.
It allows users to manage specific functionality within Kyma along with basic Kubernetes resources.
It allows users to manage specific functionality within Kyma along with basic Kubernetes resources.
The Console provides an extensibility mechanism which allows you to seamlessly integrate UI parts to achieve additional functionality.

## Details
Expand All @@ -19,6 +12,6 @@ This section provides details related to the configuration of the Console.

### Configuration

The deployment of the Console includes a [ConfigMap](templates/configmap.yaml).
The ConfigMap introduces a `config.js` file that is mounted as the asset of the Console application and injected as a configuration file.
The deployment of the Console includes a [ConfigMap](templates/configmap.yaml).
The ConfigMap introduces a `config.js` file that is mounted as the asset of the Console application and injected as a configuration file.
Use this mechanism to overwrite the default configuration with custom values resulting from the Helm chart installation.
12 changes: 2 additions & 10 deletions resources/core/charts/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
```
_____
| __ \
| | | | ___ ___ ___
| | | |/ _ \ / __/ __|
| |__| | (_) | (__\__ \
|_____/ \___/ \___|___/

```
# Docs

## Overview

This chart consists of:
* `content-ui` chart - UI application that displays documentation as part of the Console UI.
* `documentation` chart - It contains a Job that after main installation uploads documentation to Minio.
* `documentation` chart - It contains a Job that after main installation uploads documentation to Minio.
9 changes: 1 addition & 8 deletions resources/core/charts/environments/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
```
______ _ _
| ____| (_) | |
| |__ _ ____ ___ _ __ ___ _ __ _ __ ___ ___ _ __ | |_ ___
| __| | '_ \ \ / / | '__/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __/ __|
| |____| | | \ V /| | | | (_) | | | | | | | | | __/ | | | |_\__ \
|______|_| |_|\_/ |_|_| \___/|_| |_|_| |_| |_|\___|_| |_|\__|___/
```
# Environments

## Overview

Expand Down
9 changes: 1 addition & 8 deletions resources/core/charts/event-bus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
```
______ _ ____
| ____| | | | _ \
| |____ _____ _ __ | |_ | |_) |_ _ ___
| __\ \ / / _ \ '_ \| __| | _ <| | | / __|
| |___\ V / __/ | | | |_ | |_) | |_| \__ \
|______\_/ \___|_| |_|\__| |____/ \__,_|___/
```
# Event Bus

## Prerequisites

Expand Down
Loading