Commit Graph

145 Commits

Author SHA1 Message Date
Zheng Xi Zhou e090ab1dc0
Guide on how to generate a Terraform addon in one click (#494)
* Guide on how to generate a Terraform addon in one click

Guide of Terraform addon extension

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* use Makefile target to generate a Terraform addon

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* address comments

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* Update sidebars.js

Co-authored-by: Jianbo Sun <wonderflow@icloud.com>
Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/version-v1.2.json

Co-authored-by: Jianbo Sun <wonderflow@icloud.com>
Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* update doc

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* fix version-v1.2.json

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

Co-authored-by: Jianbo Sun <wonderflow@icloud.com>
2022-02-15 20:11:54 +08:00
Jianbo Sun d2364f9754 Fix: use raw instead k8s object as we didn't have that type
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-02-15 13:42:50 +08:00
Jianbo Sun c909c1bf75 Feat: refine addon extension docs
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-02-14 19:27:14 +08:00
wyike cae5c0ac3c
fix-duplicate (#505)
Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
2022-02-14 17:53:57 +08:00
barnettZQG c84f2cb79f Docs: change upgrade doc
Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
2022-02-10 14:31:10 +08:00
Wei (段少) b331ff438b
update addon en (#481)
* update addon en

* Update docs/platform-engineers/addon/intro.md

Co-authored-by: Zheng Xi Zhou <zzxwill@gmail.com>

Co-authored-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-29 11:29:42 +08:00
wyike 1226c8278b
Fix: notice for deprecated outdated helm (#483)
* fix:deprecated helm

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* modify 1.2

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
2022-01-27 23:52:21 +08:00
Zheng Xi Zhou 8dc4311ee9
Fix invalid link of installing cloud resources links (#469)
* Fix invalid link of installing cloud resources links

As the previous link of installing cloud resources in `provision and consume
cloud resources` is invalid, fixed it. Also update the wrong file name

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* Update deploy cloud resources in Chinese

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-27 16:55:23 +08:00
Diego Pinheiro fae918f844
fix - typo (#477)
Signed-off-by: GitHub <noreply@github.com>
2022-01-26 10:11:17 +08:00
Zheng Xi Zhou 0b1c81f5b3
Add "extend cloud resources" to `extension` section (#466)
* Add "extend cloud resources" to `extension` section

Added the doc on extending cloud resources to the section of `extension`

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* fix doc link issue

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* address comments

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-24 14:05:21 +08:00
wyike c6d7e0a094
exract addon out (#473)
* exract addon out

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* version 1.2 sidebar

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* fix comments

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
2022-01-24 11:44:58 +08:00
Zheng Xi Zhou 88efd55fbd
Update Terraform contribution doc (#462)
Added flag `--local` to accept local file of Terraform resource or
module. Added examples in contribution doc

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-20 15:51:08 +08:00
seedsunrise1 3f9bfa29ad
Update observability.md (#459)
fix disk-size param
2022-01-20 11:59:46 +08:00
Yin Da 790c5767df Docs: update bootstrap parameters and performance finetuning
Signed-off-by: Yin Da <yd219913@alibaba-inc.com>
2022-01-14 16:51:00 +08:00
Tianxin Dong d50c71e00f
Fix: fix notification docs (#433)
Signed-off-by: FogDong <dongtianxin.tx@alibaba-inc.com>
2022-01-13 20:32:36 +08:00
Jianbo Sun 3870f8de4c
Feat: update cli command and use vela up (#426)
* Feat: update cli command and use vela up

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* refine vela CLI how-to

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Add more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Update cli doc

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: refine more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* refine more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
2022-01-12 21:27:19 +08:00
Zheng Xi Zhou c8b6f4696c Update docs/platform-engineers/components/component-terraform.md
Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-11 20:33:09 +08:00
Zheng Xi Zhou 9aca3de3cc Update the section of generating ComponentDefinition
Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-11 20:33:09 +08:00
Zheng Xi Zhou cf73a6e02d Fix: update Terraform ComponentDefinition development doc
Update the docs of developing a Terraform typed ComponentDefinition,
and added the section of automatically generated official site docs.

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-11 20:33:09 +08:00
Zheng Xi Zhou dabf2e241f
Update the installation of addon observability (#408)
Updated the installation guide of addon observability

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
2022-01-03 11:57:07 +08:00
barnettZQG 26ba486c02
Docs: change latest version to 1.2.0-rc.2 (#405)
Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
2021-12-30 19:05:52 +08:00
barnettZQG d5037454ab
Docs: change core concept (#396)
* Docs: change core concept

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Docs: release version 1.2.0-rc.1

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Docs: change core concept

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
2021-12-25 17:39:33 +08:00
Wei (段少) e9597b23cf
Doc: V1.2.0 Beta.3 (#395)
* adjust sidebar: getting-started, deliver-app and manage-app (#371)

* Deliver first your app (#379)

* adjust sidebar of deliver your app

* Add: first vela app

* multi-env

* Deliver first your app (#381)

* adjust sidebar of deliver your app

* Add: first vela app

* multi-env

* multi cluster and scaler

* Feat: change core concept doc (#382)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* update multi-cluster (#383)

* change install and quick-start doc (#384)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* finishing ZH (#385)

* Docs: add k8s objects doc (#386)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Add EN: core concept (#388)

* Docs: add helm doc (#389)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* V1.2 en 02 (#390)

* Add: Deploy First Application

* Add EN: install

* V1.2 en 03 (#392)

* Add: deploy Kubernetes raw resource

* Add: helm chart

* Docs: change latest version (#394)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>

* Doc: v1.2.0 Beta.3

* fix check-linl

Signed-off-by: BinaryHB0916 <davidduan0916@gmail.com>

* Update: quick-start-cli

* Update

Co-authored-by: barnettZQG <barnett.zqg@gmail.com>
2021-12-21 19:43:22 +08:00
wyike 2465aec91b
Feat: upgrede docs modify (#380)
Signed-off-by: wangyike <wangyike_wyk@163.com>
2021-12-14 16:11:34 +08:00
yangsoon 4662edd872
Doc: add velaql doc (#374)
* Doc: add velaql doc

Signed-off-by: yangsoon <yangsoonlx@gmail.com>

* Update docs/platform-engineers/system-operation/velaql.md

Co-authored-by: Wei (段少) <davidduan0916@gmail.com>

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
Co-authored-by: Wei (段少) <davidduan0916@gmail.com>
2021-12-03 14:45:38 +08:00
Hongchao Deng f56acdce3d
Doc: Addon Management (#372)
* Doc: Addon Management

* comment

* fix
2021-11-30 16:17:31 +08:00
qiaozp 6e1c47600c
fix observability document (#369) 2021-11-18 12:06:50 +08:00
Somefive e9cae9a756
Feat: add config for reconcile timeout in bootstrap parameter (#362) 2021-11-08 19:14:26 +08:00
qiaozp 1736c7d1d4
remove addon with no defs (#358) 2021-10-28 17:46:40 +08:00
Wei (段少) e5af815769
Update vela-core CRDs (#357) 2021-10-28 17:45:51 +08:00
Zheng Xi Zhou 5e0237de17
Use a bulleted list for unordered items (#354)
Change some numbered lists to bullted list as they are unordered items

Ref: https://developers.google.com/tech-writing/one/lists-and-tables
2021-10-22 00:07:54 +08:00
Zheng Xi Zhou 800e109961
Use acronyms properly (#353)
Do not cycle back-and-forth between the acronym and the expanded
version in the same document.

Ref: https://developers.google.com/tech-writing/one/words#use_acronyms_properly
2021-10-22 00:07:23 +08:00
Zheng Xi Zhou 95e21979fd
Fix: addon terraform isn't installed by default (#352)
Update the docs in v1.1 and the current version
2021-10-22 00:06:57 +08:00
Lei Zhang (Harry) 7c2933e253
Align en with cn docs (#346) 2021-10-16 14:46:30 +08:00
Tianxin Dong 10deb45d27
Docs: fix init doc (#316)
* Docs: fix init doc

* refactor the doc

* add init en version

* fix the example

* update the 1.1 version
2021-10-13 10:41:18 +08:00
yangsoon 7c8ab0235d
Feat: add script help generate versioned docs (#322)
* Feat: add script help generate versioned docs

* sync docs to v1.1
2021-10-09 14:12:30 +08:00
Jianbo Sun 88300543b2
fix link path (#317) 2021-10-09 10:15:00 +08:00
Lei Zhang (Harry) 21ab5091e7
Fix en docs next (#313) 2021-10-02 14:55:57 +08:00
Jian.Li 9ddeec7419
Feat: add ws.#DoVar cue-action (#302) 2021-09-24 16:48:50 +08:00
Somefive 14722106ff
Docs: add guide for enable multicluster (#296)
* Docs: add guide for enable multicluster

* Docs: move multicluster to advance install
2021-09-23 19:03:58 +08:00
yangsoon ca931756eb
fix built-in step name (#300) 2021-09-23 17:45:05 +08:00
Somefive ba92113faa
Fix: bootstrap resync param typo (#299) 2021-09-23 15:13:19 +08:00
Lei Zhang (Harry) 4557657f24
Fix typos etc. (#292) 2021-09-22 10:06:05 +08:00
Tianxin Dong b68ddae1c1
Fix: fix the apply component (#289) 2021-09-17 22:09:06 +08:00
yangsoon e45f87198d
Feat: release v1.1 docs (#281) 2021-09-15 15:24:32 +08:00
Somefive 964e3dfb14
Docs: rename multi-env to deploy2env (#284) 2021-09-15 14:59:37 +08:00
Tianxin Dong 2701b5e707
Fix: load in cue actions (#283) 2021-09-15 14:02:00 +08:00
Jianbo Sun a0ae54d901
add multi cluster deploy use case (#274) 2021-09-15 10:19:02 +08:00
Somefive 144ea9b34d
Docs: initialize multi cluster references (#272) 2021-09-14 23:07:35 +08:00
Tianxin Dong 7b80a8aaf5
Docs: fix workflow docs (#273) 2021-09-14 22:00:16 +08:00