Feat: add fig auto-complete script doc

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-09-19 16:03:00 +08:00
parent d73c0349c3
commit be2525cf60
6 changed files with 68 additions and 2 deletions

View File

@ -0,0 +1,32 @@
---
title: Integrate fig auto-complete
---
## Installation & Usage
- Using Homebrew: `brew install --cask fig`
- Download from their website: [fig.io](https://fig.io/welcome)
![demo](../resources/fig-demo.gif)
## Maintain KubeVela auto-complete scripts
- Fork the git repo [withfig/autocomplete](https://github.com/withfig/autocomplete)
- Clone your forked repo
```
# Replace `YOUR_GITHUB_USERNAME` with your own github username
git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git fig-autocomplete
cd fig-autocomplete
# Add withfig/autocomplete as a remote
git remote add upstream https://github.com/withfig/autocomplete.git
# Install packages
npm install
```
- edit vela-cli spec in `src/vela.ts`, the spec is easy to understand
- run dev mode to review your change, use `npm run dev`
- send a PR to the main repo

BIN
docs/resources/fig-demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 751 KiB

View File

@ -1,4 +1,4 @@
const {Component} = require('react');
const { Component } = require('react');
module.exports = {
docs: [
@ -252,6 +252,7 @@ module.exports = {
'contributor/non-code-contribute',
'contributor/code-contribute',
'contributor/cli-ref-doc',
'contributor/fig-auto-complete',
],
},
{

View File

@ -0,0 +1,32 @@
---
title: Integrate fig auto-complete
---
## Installation & Usage
- Using Homebrew: `brew install --cask fig`
- Download from their website: [fig.io](https://fig.io/welcome)
![demo](../resources/fig-demo.gif)
## Maintain KubeVela auto-complete scripts
- Fork the git repo [withfig/autocomplete](https://github.com/withfig/autocomplete)
- Clone your forked repo
```
# Replace `YOUR_GITHUB_USERNAME` with your own github username
git clone https://github.com/YOUR_GITHUB_USERNAME/autocomplete.git fig-autocomplete
cd fig-autocomplete
# Add withfig/autocomplete as a remote
git remote add upstream https://github.com/withfig/autocomplete.git
# Install packages
npm install
```
- edit vela-cli spec in `src/vela.ts`, the spec is easy to understand
- run dev mode to review your change, use `npm run dev`
- send a PR to the main repo

Binary file not shown.

After

Width:  |  Height:  |  Size: 751 KiB

View File

@ -261,7 +261,8 @@
"Contribution Guide": [
"contributor/non-code-contribute",
"contributor/code-contribute",
"contributor/cli-ref-doc"
"contributor/cli-ref-doc",
"contributor/fig-auto-complete"
]
},
{