docs: updates from qa (#360)
* numbering * startup-from-main-menu-and-localhost * wsl-browser-error * open-localhost-alternate * tasks-menu * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
This commit is contained in:
Mendon Kissling
GitHub
parent
b5feba3dff
commit
2aecfc570c
4 changed files with 29 additions and 6 deletions
|
|
@ -39,7 +39,7 @@ This command will:
|
|||
- Create a versioned sidebar file at `versioned_sidebars/version-1.0.0-sidebars.json`
|
||||
- Append the new version to `versions.json`
|
||||
|
||||
3. After creating a version, update the Docusaurus configuration to include multiple versions.
|
||||
2. After creating a version, update the Docusaurus configuration to include multiple versions.
|
||||
`lastVersion:'1.0.0'` makes the '1.0.0' release the `latest` version.
|
||||
`current` is the work-in-progress docset, accessible at `/docs/next`.
|
||||
To remove a version, remove it from `onlyIncludeVersions`.
|
||||
|
|
@ -62,14 +62,14 @@ docs: {
|
|||
},
|
||||
```
|
||||
|
||||
4. Test the deployment locally.
|
||||
3. Test the deployment locally.
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
npm run serve
|
||||
```
|
||||
|
||||
5. To add subsequent versions, repeat the process, first running the CLI command then updating `docusaurus.config.js`.
|
||||
4. To add subsequent versions, repeat the process, first running the CLI command then updating `docusaurus.config.js`.
|
||||
|
||||
```bash
|
||||
# Create version 2.0.0 from current docs
|
||||
|
|
|
|||
|
|
@ -86,6 +86,19 @@ You can select multiple files.
|
|||
The ingestion process may take some time, depending on the size of your documents.
|
||||
4. When ingestion is complete, your documents are available in the Knowledge screen.
|
||||
|
||||
If ingestion fails, click **Status** to view the logged error.
|
||||
|
||||
## Monitor ingestion tasks
|
||||
|
||||
When you upload files, process folders, or sync documents, OpenRAG processes them as background tasks.
|
||||
A badge appears on the <Icon name="Bell" aria-hidden="true"/> **Tasks** icon when there are active tasks running.
|
||||
To open the Tasks menu, click <Icon name="Bell" aria-hidden="true"/> **Tasks**.
|
||||
|
||||
**Active Tasks** shows tasks that are currently processing.
|
||||
A **Pending** task is queued and waiting to start, a **Running** task is actively processing files, and a **Processing** task is performing ingestion operations. For each active task, you can find the task ID, start time, duration, the number of files processed so far, and the total files.
|
||||
|
||||
You can cancel active tasks by clicking <Icon name="X" aria-hidden="true"/> **Cancel**. Canceling a task stops processing immediately and marks the task as failed.
|
||||
|
||||
## Explore knowledge
|
||||
|
||||
The **Knowledge** page lists the documents OpenRAG has ingested into the OpenSearch vector database's `documents` index.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Once OpenRAG is running, use the TUI to monitor your application, control your c
|
|||
|
||||
If you prefer running Podman or Docker containers and manually editing `.env` files, see [Install OpenRAG Containers](/get-started/docker).
|
||||
|
||||
## Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
- Install [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/)
|
||||
- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
||||
|
|
@ -185,7 +185,8 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
Command completed successfully
|
||||
```
|
||||
6. To start the Docling service, under **Native Services**, click **Start**.
|
||||
7. To open the OpenRAG application, click **Open App**.
|
||||
7. To open the OpenRAG application, navigate to the TUI main menu, and then click **Open App**.
|
||||
Alternatively, in your browser, navigate to `localhost:3000`.
|
||||
8. Continue with [Application Onboarding](#application-onboarding).
|
||||
</TabItem>
|
||||
<TabItem value="Advanced setup" label="Advanced setup">
|
||||
|
|
@ -212,7 +213,8 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
Command completed successfully
|
||||
```
|
||||
8. To start the Docling service, under **Native Services**, click **Start**.
|
||||
9. To open the OpenRAG application, click **Open App**.
|
||||
9. To open the OpenRAG application, navigate to the TUI main menu, and then click **Open App**.
|
||||
Alternatively, in your browser, navigate to `localhost:3000`.
|
||||
You are presented with your provider's OAuth sign-in screen.
|
||||
After sign-in, you are redirected to the redirect URI.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,6 +13,14 @@ This page provides troubleshooting advice for issues you might encounter when us
|
|||
Check that `OPENSEARCH_PASSWORD` set in [Environment variables](/reference/configuration) meets requirements.
|
||||
The password must contain at least 8 characters, and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character that is strong.
|
||||
|
||||
## OpenRAG fails to start from the TUI with "Operation not supported" error
|
||||
|
||||
This error occurs when starting OpenRAG with the TUI in [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install).
|
||||
|
||||
The error occurs because OpenRAG is running within a WSL environment, so `webbrowser.open()` can't launch a browser automatically.
|
||||
|
||||
To access the OpenRAG application, open a web browser and enter `http://localhost:3000` in the address bar.
|
||||
|
||||
## Langflow connection issues
|
||||
|
||||
Verify the `LANGFLOW_SUPERUSER` credentials set in [Environment variables](/reference/configuration) are correct.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue