Skip to content

Commit 1abb300

Browse files
authored
docs: backport content updates from incubator-texera-site (#5628)
### What changes were proposed in this PR? - Backport doc content that was edited directly on the website (`apache/incubator-texera-site`, `content/docs/latest/`) back into this repo's `docs/` source, so `docs/` is the source of truth for the docs sync. - `getting-started/installing-using-docker.md`: use the released download link instead of the RC5 dev-dist URL, add "Enable the Texera Agent" and "Add more LLMs or providers" sections, and fix the stop command to `docker compose --profile examples stop`. - `tutorials/migrate-jupyter-notebook.md`: correct the `hub.texera.io/dashboard/...` URLs. - Each file keeps its existing local front matter; website-only fields (`aliases`) and the `_index.md` `/docs/latest/` routing differences are intentionally not pulled, since they are site-specific. ### Any related issues, documentation, or discussions? Closes: #5627 ### How was this PR tested? - Docs-only change, no code paths affected, so no automated tests apply. - To verify content: open `docs/getting-started/installing-using-docker.md` and confirm the download link points to `downloads.apache.org/incubator/texera/1.1.0-incubating/...`, the "Enable the Texera Agent" and "Add more LLMs or providers" sections are present, and the stop command reads `docker compose --profile examples stop`. - To verify content: open `docs/tutorials/migrate-jupyter-notebook.md` and confirm the example links use the `hub.texera.io/dashboard/...` paths. - To confirm parity: diff `docs/` against the website's `content/docs/latest/` bodies and confirm the only remaining differences are website-only front matter and `_index.md` routing. ### Was this PR authored or co-authored using generative AI tooling? Generated-by: Claude Opus 4.8
1 parent ae3128d commit 1abb300

2 files changed

Lines changed: 66 additions & 25 deletions

File tree

docs/getting-started/installing-using-docker.md

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ If either command produces output, that port is occupied by another process. You
5050

5151
---
5252

53+
## Download Texera
5354

54-
## Download the docker compose tarball from the release
55+
Download the [docker compose tarball](https://downloads.apache.org/incubator/texera/1.1.0-incubating/apache-texera-1.1.0-incubating-docker-compose.tar.gz) and extract it.
5556

56-
Download by clicking [here](https://dist.apache.org/repos/dist/dev/incubator/texera/1.1.0-incubating-RC5/apache-texera-1.1.0-incubating-docker-compose.tar.gz) and extract it.
5757

5858
## Launch Texera
5959

@@ -62,19 +62,13 @@ Enter the extracted directory and run the following command to start Texera:
6262
docker compose --profile examples up
6363
```
6464

65-
This command will start docker containers that host the Texera services, and pre-create two example workflows and datasets.
65+
This command will start docker containers that host the Texera services, and pre-create two example workflows and datasets.
6666

6767
If you don't want to have these examples pre-created, run the following command instead:
6868
```bash
6969
docker compose up
7070
```
7171

72-
To enable the AI copilot panel, also pass your LLM provider key inline. For example, with Anthropic:
73-
```bash
74-
export ANTHROPIC_API_KEY=<your-api-key>
75-
docker compose --profile examples up
76-
```
77-
7872
> If you see the error message like `unable to get image 'nginx:alpine': Cannot connect to the Docker daemon at unix:///Users/kunwoopark/.docker/run/docker.sock. Is the docker daemon running?`, please make sure Docker Desktop is installed and running
7973
8074
> When you start Texera for the first time, it will take around 5 minutes to download needed images.
@@ -103,7 +97,7 @@ Press `Ctrl+C` in the terminal to stop Texera.
10397

10498
If you already closed the terminal, you can go to the installation folder and run:
10599
```bash
106-
docker compose stop
100+
docker compose --profile examples stop
107101
```
108102
to stop Texera.
109103

@@ -118,6 +112,28 @@ docker compose --profile examples down -v
118112
> ⚠️ Warning: This will permanently delete all the data used by Texera.
119113
120114

115+
## Enable the Texera Agent
116+
117+
The Texera agent is powered by a large language model (LLM). By default, Texera uses [Claude Haiku 4.5](https://www.anthropic.com/claude/haiku) as the LLM and queries it through [LiteLLM](https://docs.litellm.ai/). Without an API key, the Texera agent panel still appears but model calls will fail with a provider auth error.
118+
119+
To enable it:
120+
121+
1. [Stop Texera](#stop) if it is already running.
122+
2. Get an API key for the LLM. Since Claude Haiku 4.5 is enabled by default, you need an [Anthropic API key](https://console.anthropic.com/settings/keys).
123+
3. Export the key and restart Texera:
124+
```bash
125+
export ANTHROPIC_API_KEY=sk-ant-...
126+
docker compose --profile examples up
127+
```
128+
129+
Once Texera is up, create a new workflow and open the Texera agent panel at the bottom right. Type a task like:
130+
131+
> For /texera/popular-movies-of-imdb/v1/TMDb_updated.csv, visualize the top 10 most-voted movies.
132+
133+
To switch providers or add more LLMs, see [Add more LLMs or providers](#add-more-llms-or-providers).
134+
135+
136+
121137
## Advanced Settings
122138

123139
Before making any of the changes below, please [stop Texera](#stop) first. Once you finish the changes, [restart Texera](#restart) to apply them.
@@ -161,6 +177,45 @@ $ docker compose up
161177
y // answer y to this prompt
162178
```
163179

180+
### Add more LLMs or providers
181+
Only Claude Haiku 4.5 is enabled by default. To add more LLMs, open `litellm-config.yaml` in the installation folder and append entries under `model_list`. Each entry follows this shape:
182+
```diff
183+
model_list:
184+
...
185+
+ - model_name: <name shown in Texera>
186+
+ litellm_params:
187+
+ model: <provider model id>
188+
+ api_key: "os.environ/<API_KEY_ENV_VAR>"
189+
```
190+
For example, to add OpenAI's GPT-5.2 and Google's Gemini 2.5 Pro:
191+
```diff
192+
model_list:
193+
...
194+
+ - model_name: gpt-5.2
195+
+ litellm_params:
196+
+ model: gpt-5.2
197+
+ api_key: "os.environ/OPENAI_API_KEY"
198+
+
199+
+ - model_name: gemini-2.5-pro
200+
+ litellm_params:
201+
+ model: gemini/gemini-2.5-pro
202+
+ api_key: "os.environ/GEMINI_API_KEY"
203+
```
204+
Make sure to set the corresponding API key environment variable when you launch Texera (see [Enable the Texera Agent](#enable-the-texera-agent)). Get keys from each provider's console — for example, [OpenAI](https://platform.openai.com/api-keys) or [Google](https://aistudio.google.com/apikey).
205+
206+
If your provider is not Anthropic, OpenAI, or Google, also pass its key into the LiteLLM container by editing `docker-compose.yml`:
207+
```diff
208+
litellm:
209+
...
210+
environment:
211+
ANTHROPIC_API_KEY: ${ANTHROPIC_API_KEY:-}
212+
OPENAI_API_KEY: ${OPENAI_API_KEY:-}
213+
GEMINI_API_KEY: ${GEMINI_API_KEY:-}
214+
+ <NEW_API_KEY>: ${<NEW_API_KEY>:-}
215+
```
216+
217+
For the full list of supported providers and model IDs, see the [LiteLLM proxy config docs](https://docs.litellm.ai/docs/providers).
218+
164219
## Troubleshooting
165220

166221
### Port conflicts

docs/tutorials/migrate-jupyter-notebook.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Migrating notebook code into Texera operators, then wiring those operators with
1616

1717
## 2. Example: convert a "tweet analysis" notebook into a workflow
1818

19-
> The [notebook](https://hub.texera.io/user/dataset/124), [dataset](https://hub.texera.io/user/dataset/124) and [workflow](https://hub.texera.io/user/workflow/1162) in this example are available on [TexeraHub](https://hub.texera.io/about).
19+
> The [notebook](https://hub.texera.io/dashboard/user/dataset/124), [dataset](https://hub.texera.io/dashboard/user/dataset/124) and [workflow](https://hub.texera.io/dashboard/user/workspace/1162) in this example are available on [TexeraHub](https://hub.texera.io/dashboard/about).
2020
2121
### Notebook Overview
2222
We will use a Tweet-Analysis notebook to demonstrate the migration process. The notebook has three cells:
@@ -174,17 +174,3 @@ Texera contains more than 110 built-in operators that cover data loading, cleani
174174
- **Identify the data dependencies in the Python code in order to connect operators**
175175

176176
In Texera, data flows along links. Before wiring operators, review the notebook to understand which variables feed which; then reproduce those dependencies via links so the executions matches the original notebook.
177-
178-
179-
180-
181-
182-
183-
184-
185-
186-
187-
188-
189-
190-

0 commit comments

Comments
 (0)