From cc5e257b74259c8abb9c5c15d87237f99eed35be Mon Sep 17 00:00:00 2001 From: Zhiming Ma Date: Thu, 9 Nov 2023 14:47:49 +0800 Subject: [PATCH] docs: update docs about Tabby Cloud. (#740) --- clients/intellij/README.md | 6 +++--- clients/vim/doc/tabby.txt | 4 ++-- clients/vscode/README.md | 7 +++---- clients/vscode/assets/walkthroughs/server.md | 11 ++--------- clients/vscode/assets/walkthroughs/setApiEndpoint.md | 8 +++++--- clients/vscode/assets/walkthroughs/setApiEndpoint.png | 4 ++-- clients/vscode/assets/walkthroughs/statusbarReady.png | 3 +++ 7 files changed, 20 insertions(+), 23 deletions(-) create mode 100644 clients/vscode/assets/walkthroughs/statusbarReady.png diff --git a/clients/intellij/README.md b/clients/intellij/README.md index c524467..c81f686 100644 --- a/clients/intellij/README.md +++ b/clients/intellij/README.md @@ -1,5 +1,7 @@ # Tabby Plugin for IntelliJ Platform [![JetBrains plugins](https://img.shields.io/jetbrains/plugin/d/22379-tabby)](https://plugins.jetbrains.com/plugin/22379-tabby) +[![Slack Community](https://shields.io/badge/Tabby-Join%20Slack-red?logo=slack)](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) + Tabby is an AI coding assistant that can suggest multi-line code or full functions in real-time. @@ -7,14 +9,12 @@ Tabby IntelliJ Platform plugin works with all [IntelliJ Platform IDEs](https://p ## Getting Started -1. Set up the Tabby Server: you can build your self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation/), or get a Tabby Cloud hosted server [here](https://app.tabbyml.com). - **Note**: Tabby Cloud is currently in **closed** beta. Join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and ask in Tabby Cloud channel to get a beta invite. +1. Set up the Tabby Server: you can build your self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation/). 2. Install Tabby plugin from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/22379-tabby). 3. Install [Node.js](https://nodejs.org/en/download/) version 18.0 or higher. 4. Open the settings by clicking on the Tabby plugin status bar item and select `Open Settings...`. 1. Fill in the server endpoint URL to connect the plugin to your Tabby server. * If you are using default port `http://localhost:8080`, you can skip this step. - * If you are using a Tabby Cloud server endpoint, follow the instructions provided in the popup messages to complete the authorization process. 2. Enter the node binary path into the designated field * If node binary is already accessible via your `PATH` environment variable, you can skip this step. * Remember to save the settings and restart the IDE if you made changes to this option. diff --git a/clients/vim/doc/tabby.txt b/clients/vim/doc/tabby.txt index adaee68..2f7b160 100644 --- a/clients/vim/doc/tabby.txt +++ b/clients/vim/doc/tabby.txt @@ -23,8 +23,8 @@ Commands~ :Tabby status Check the status of Tabby. Report error message if any issue exists. *:Tabby-auth* -:Tabby auth Check the status of Tabby. Report error message if any - issue exists. +:Tabby auth Start to complete the authentication process. Only used + when you are using a Tabby Cloud endpoint. *:Tabby-help* :Tabby help [subject] Search for help information in this document using VIM command `:help`. diff --git a/clients/vscode/README.md b/clients/vscode/README.md index 7c54eda..3240dea 100644 --- a/clients/vscode/README.md +++ b/clients/vscode/README.md @@ -10,7 +10,7 @@ Tabby is an AI coding assistant that can suggest multi-line code or full functio Tabby VSCode extension is compatible with `VSCode ≥ 1.82.0`, as well as web environments like [vscode.dev](https://vscode.dev). For more information, please check out our [Website](https://tabbyml.com/) and [GitHub](https://github.com/TabbyML/tabby). -If you encounter any problem or have any suggestion, please [open an issue](https://github.com/TabbyML/tabby/issues/new)! +If you encounter any problem or have any suggestion, please [open an issue](https://github.com/TabbyML/tabby/issues/new), or join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) for support. ## Demo @@ -22,9 +22,8 @@ Try our online demo [here](https://tabby.tabbyml.com/playground). Once you have installed the Tabby VSCode extension, you can easily get started by following the built-in walkthrough guides. You can access the walkthrough page at any time by using the command `Tabby: Getting Started`. -1. **Setup the Tabby server**: You have two options to set up your Tabby server. You can either build your own self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation) or get a Tabby Cloud hosted server [here](https://app.tabbyml.com). - **Note**: Tabby Cloud is currently in **closed** beta. Join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and ask in #help-self-hosting channel to get a beta invite. -2. **Connect the extension to your Tabby server**: Use the command `Tabby: Specify API Endpoint of Tabby` to connect the extension to your Tabby server. If you are using a Tabby Cloud server endpoint, follow the instructions provided in the popup messages to complete the authorization process. +1. **Setup the Tabby server**: You can build your own self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation). +2. **Connect the extension to your Tabby server**: Use the command `Tabby: Specify API Endpoint of Tabby` to connect the extension to your Tabby server. Once the setup is complete, Tabby will automatically provide inline suggestions. You can accept the suggestions by simply pressing the `Tab` key. diff --git a/clients/vscode/assets/walkthroughs/server.md b/clients/vscode/assets/walkthroughs/server.md index 3ebefa7..661bbad 100644 --- a/clients/vscode/assets/walkthroughs/server.md +++ b/clients/vscode/assets/walkthroughs/server.md @@ -1,12 +1,5 @@ -# Tabby Server - -Choose your preferred way to host your Tabby server, either through Tabby Cloud or by self-hosting. - -## Self-Hosting +## Self-Hosted Tabby Server Tabby is an open-source project and supports self-hosting. For more details, please refer to our [self-hosting guide](https://tabby.tabbyml.com/docs/installation/) and visit our [Github repository](https://github.com/tabbyml/tabby). -## Tabby Cloud - -You can get a Tabby Cloud account [here](https://app.tabbyml.com). Once you create or join a workspace, you will receive a URL for your Tabby server endpoint. -**Note**: Tabby Cloud is currently in **closed** beta. Join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and ask in #help-self-hosting channel to get a beta invite. +If you encounter any problems during server setup, please join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) for support, or [open an issue](https://github.com/TabbyML/tabby/issues/new) on Github. diff --git a/clients/vscode/assets/walkthroughs/setApiEndpoint.md b/clients/vscode/assets/walkthroughs/setApiEndpoint.md index 6b0f097..c831c7c 100644 --- a/clients/vscode/assets/walkthroughs/setApiEndpoint.md +++ b/clients/vscode/assets/walkthroughs/setApiEndpoint.md @@ -1,9 +1,11 @@ # Connect to Tabby Server -When you execute the command `Tabby: Specify API Endpoint of Tabby`, you will see a prompt asking you to enter the API endpoint of your Tabby server. +**Note** If you are using default port `http://localhost:8080`, you can simply skip this step. + +Open the command palette and execute the command `Tabby: Specify API Endpoint of Tabby`, you will see a prompt asking you to enter the API endpoint of your Tabby server. ![setApiEndpoint](./setApiEndpoint.png) -Once the connection is established, you will see the status bar showing the check mark. +Once the connection is established, you will see the Tabby status bar item showing checkmark. -If you are using a Tabby Cloud server endpoint, please follow the popup messages to complete authorization. +![statusbarReady](./statusbarReady.png) diff --git a/clients/vscode/assets/walkthroughs/setApiEndpoint.png b/clients/vscode/assets/walkthroughs/setApiEndpoint.png index 7d4f3b6..48dfab1 100644 --- a/clients/vscode/assets/walkthroughs/setApiEndpoint.png +++ b/clients/vscode/assets/walkthroughs/setApiEndpoint.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:58cc648387ca6df528c48fffc39fd28c07c77f910d577195b6cecb07aef6e17f -size 26481 +oid sha256:178fbf6e332a13dc3fe3cf458372d289cfbbed763a1d15ad74c37bb1aead40a2 +size 23012 diff --git a/clients/vscode/assets/walkthroughs/statusbarReady.png b/clients/vscode/assets/walkthroughs/statusbarReady.png new file mode 100644 index 0000000..0d0bad7 --- /dev/null +++ b/clients/vscode/assets/walkthroughs/statusbarReady.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8f3213cb3585fbb7be6988415ac001614cc807c1328ea29d1260b65d2272952 +size 13791