diff --git a/docs/contributor/fig-auto-complete.md b/docs/contributor/fig-auto-complete.md new file mode 100644 index 00000000..03eb98ab --- /dev/null +++ b/docs/contributor/fig-auto-complete.md @@ -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 + diff --git a/docs/resources/fig-demo.gif b/docs/resources/fig-demo.gif new file mode 100644 index 00000000..75dc4097 Binary files /dev/null and b/docs/resources/fig-demo.gif differ diff --git a/sidebars.js b/sidebars.js index adf593e9..61f9e4b9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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', ], }, { diff --git a/versioned_docs/version-v1.5/contributor/fig-auto-complete.md b/versioned_docs/version-v1.5/contributor/fig-auto-complete.md new file mode 100644 index 00000000..03eb98ab --- /dev/null +++ b/versioned_docs/version-v1.5/contributor/fig-auto-complete.md @@ -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 + diff --git a/versioned_docs/version-v1.5/resources/fig-demo.gif b/versioned_docs/version-v1.5/resources/fig-demo.gif new file mode 100644 index 00000000..75dc4097 Binary files /dev/null and b/versioned_docs/version-v1.5/resources/fig-demo.gif differ diff --git a/versioned_sidebars/version-v1.5-sidebars.json b/versioned_sidebars/version-v1.5-sidebars.json index 297ca932..1e79297d 100644 --- a/versioned_sidebars/version-v1.5-sidebars.json +++ b/versioned_sidebars/version-v1.5-sidebars.json @@ -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" ] }, {