Init platform builder doc

This commit is contained in:
Harry Zhang
2021-01-14 21:38:03 -08:00
parent 83ce5ec724
commit 30585f80e6
4 changed files with 25 additions and 10 deletions
+12 -6
View File
@@ -9,22 +9,28 @@
![alt](docs/resources/KubeVela-03.png)
*Make shipping applications more enjoyable.*
*Shipping apps with joy, building platforms with smile.*
# KubeVela
For developers, KubeVela is an easy-to-use tool that enables them to describe and ship their applications to Kubernetes with minimal effort.
For developers, KubeVela serves as an easy-to-use yet extensible platform that enables them to describe and ship applications to Kubernetes with minimal effort.
For platform builders, KubeVela serves as a framework that empowers them to create developer facing yet highly extensible platforms at ease.
For platform builders, KubeVela is the engine that empowers them to create such platforms at scale.
## Community
- Slack: [CNCF Slack](https://slack.cncf.io/) #kubevela channel
- Gitter: [Community](https://gitter.im/oam-dev/community)
- Gitter: [Discussion](https://gitter.im/oam-dev/community)
> NOTE: KubeVela is still in early stage and iterating quickly. It's currently under preview release.
## Quick Start
## User Guide
Quick start guides are available on [this section](https://kubevela.io/#/en/quick-start).
Quick start guides for developers are available on [this section](https://kubevela.io/#/en/quick-start).
## Platform Builder Guide
Tutorials for platform builders are available on [this section](https://kubevela.io/#/en/platform-engineers/overview).
## Documentation
+4 -3
View File
@@ -2,7 +2,7 @@
- [Introduction](/en/introduction.md)
- [Getting Started](/en/quick-start.md)
- Using KubeVela
- User Guide
- Appfile
- [Learning Appfile](/en/developers/learn-appfile.md)
- Operating
@@ -14,13 +14,14 @@
- [Port Forwarding](/en/developers/port-forward.md)
- [Check Application Logs](/en/developers/check-logs.md)
- [Execute Commands in Container](/en/developers/exec-cmd.md)
- Extensibility
- Extending
- [Managing Capabilities](/en/developers/cap-center.md)
- Configuring
- [Setting Up Deployment Environment](/en/developers/config-enviroments.md)
- [Configuring data/env in Application](/en/developers/config-app.md)
- [Alternative Commands](/en/developers/alternative-cmd.md)
- Extending KubeVela
- Platform Builder Guide
- [Add Workload Type](/en/platform-engineers/workload-type.md)
- [Add Trait](/en/platform-engineers/trait.md)
- [Add Cloud Services](/en/platform-engineers/cloud-services.md)
+8 -1
View File
@@ -1,6 +1,6 @@
# Concepts and Glossaries
This document explains some technical terms that are widely used in KubeVela, such as `application`, `service`, `workload type`, `trait` etc., from application developer's perspective. The goal is to clarify them in the context of KubeVela.
This document explains some technical terms that are widely used in KubeVela, such as `application`, `service`, `workload type`, `trait` etc., from user's perspective. The goal is to clarify them in the context of KubeVela.
## Overview
@@ -26,3 +26,10 @@ An application is defined by an `Appfile` (named `vela.yaml` by default) in Kube
## Environment
Before releasing an application to production, it's important to test the code in testing/staging workspaces. In KubeVela, we describe these workspaces as "deployment environments" or "environments" for short. Each environment has its own configuration (e.g., domain, Kubernetes namespace, configuration data, access control policy etc.) to allow user to create different deployment environments such as "test" and "production".
## What's Next
Now that you have grasped the core ideas of KubeVela. Here are some recommended next steps:
- Continue to try out [more tutorials](developers/learn-appfile.md)
- Learn how to build platforms with KubeVela following its [platform builder guide](platform-engineers/overview.md)
+1
View File
@@ -74,6 +74,7 @@ Hello World
Congratulations! You have just deployed an app using KubeVela. Here are some recommended next steps:
- Try out more [tutorials](developers/learn-appfile.md)
- Learn about KubeVela's [core concepts](https://kubevela.io/#/en/concepts) in detail
- Join our community [Slack](https://cloud-native.slack.com/archives/C01BLQ3HTJA) and/or [Gitter](https://gitter.im/oam-dev/community)
Welcome onboard and sail Vela!