Update main Kyma docs #6055
Update main Kyma docs #6055
Conversation
kazydek
requested review from
alexandra-simeonova,
bszwarc,
klaudiagrz,
majakurcius,
mmitoraj and
tomekpapiernik
as code owners
docs/kyma/01-01-in-a-nutshell.md
Outdated
| - The endpoint to register Events and APIs of external applications (Application Connector) | ||
| - The messaging channel to receive Events, enrich them, and trigger business flows using lambdas or services (Event Bus, NATS) | ||
| - CLI supported by the intuitive UI (Console) | ||
| Kyma comes equipped with those out-of-the-box functionalities: |
There was a problem hiding this comment.
| Kyma comes equipped with those out-of-the-box functionalities: | |
| Kyma comes equipped with these out-of-the-box functionalities: |
docs/kyma/01-01-in-a-nutshell.md
Outdated
| Kyma comes equipped with those out-of-the-box functionalities: | ||
|
|
||
| - Service-to-service communication and proxying (Istio-based [Service Mesh](/components/service-mesh/#overview-overview)) | ||
| - In-built [monitoring](/components/monitoring/#overview-overview), [tracing](/components/tracing/#overview-overview), and [logging](/components/logging/#overview-overview) (Grafana, Prometheus, Jaeger), Loki, Kiali) |
There was a problem hiding this comment.
| - In-built [monitoring](/components/monitoring/#overview-overview), [tracing](/components/tracing/#overview-overview), and [logging](/components/logging/#overview-overview) (Grafana, Prometheus, Jaeger), Loki, Kiali) | |
| - In-built [monitoring](/components/monitoring/#overview-overview), [tracing](/components/tracing/#overview-overview), and [logging](/components/logging/#overview-overview) (Grafana, Prometheus, Jaeger, Loki, Kiali) |
README.md
Outdated
| ## Overview | ||
|
|
||
| Kyma allows you to connect applications and third-party services in a cloud-native environment. Use it to create extensions for the existing systems, regardless of the language they are written in. Customize extensions with minimum effort and time devoted to learning their configuration details. | ||
| **Kyma** `/kee-ma/` is a platform for extending applications with microservices and [serverless](https://kyma-project.io/docs/components/serverless/) functions. It provides CLI and UI through which you can connect your application to a Kubernetes cluster and expose the application's API or Events securely thanks to the in-built [Application Connector](https://kyma-project.io/docs/components/application-connector/#overview-overview). You can then implement the business logic you require by creating microservices or functions, and triggering them to react to particular Events or calls to your application's API. To limit the time spent on coding, use the in-built cloud services from the [Service Catalog](https://kyma-project.io/docs/components/service-catalog/), exposed by [Service Brokers](https://kyma-project.io/docs/components/service-catalog/#service-brokers-service-brokers) from such cloud providers as GCP, Azure, and AWS. |
There was a problem hiding this comment.
to not maintain 2 different texts here and website I suggest we simply copy/paste here what we have on the website
There was a problem hiding this comment.
As agreed we would keep them as they describe the whole flow in more detail.
|
|
||
| Go to the [Kyma project website](https://kyma-project.io/) to learn more about the product, its features, and components. | ||
| Go to the [Kyma project website](https://kyma-project.io/) to learn more about our project, its features, and components. |
There was a problem hiding this comment.
if we will have here what is on the website just change this text to link to docs only, or remove at all and have the links we have on a website (the ones we discussed today, to all features and to components)
README.md
Outdated
| <ul style="list-style-type: none; display: flex; flex-wrap: wrap;"> | ||
| <li> | ||
| <a href="https://www.sap.com/index.html" target="_blank"> | ||
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/59/SAP_2011_logo.svg" alt="SAP" style="width: 200px;"/> |
There was a problem hiding this comment.
looks like it is ignored in the preview style="width: 200px;"
There was a problem hiding this comment.
I think because you use indentations in HTML in markdown document, imho you should align to left all html tags
| </a> | ||
| </ul> | ||
|
|
||
| Read about their [use cases](https://kyma-project.io/#used-by). |
There was a problem hiding this comment.
I like we do no duplicate all data from kyma-project website but just put icons and refer to proper view with all details. I would just prefer to also remove the links, so nobody goes to website of the company from the readme
| - The endpoint to register Events and APIs of external applications (Application Connector) | ||
| - The messaging channel to receive Events, enrich them, and trigger business flows using lambdas or services (Event Bus, NATS) | ||
| - CLI supported by the intuitive UI (Console) | ||
| Kyma comes equipped with these out-of-the-box functionalities: |
There was a problem hiding this comment.
I think I saw it somewhere already :)
makes sense to have it here, we just need to make sure all TWs know about it, like about Key features and Components docs, so this sections are always up to date. Like for example the API gateway link in future once new gateway is introduced. Same thing with compass of knative functions
| ├── scripts # Scripts used for building | ||
| └── tools # Source code of utilities used, for installation, testing, and more | ||
| ``` | ||
| ## Kyma users |
There was a problem hiding this comment.
instruction from @magicmatatjahu will need info for maintainer that merges, that he needs to manually add new company here
|
💩 Documentation preview fail... 💩 Built with commit b6ae01a https://app.netlify.com/sites/kyma-project-docs-preview/deploys/5db2f1f67d34bd00078e3a38 |
|
|
Description
Changes proposed in this pull request:
README.mdin the project (changed the Overview content, removed the Project structure section, added Kyma users section with logos)Related issue(s)
See also #kyma-project/website#363