Skip to content

Commit f131942

Browse files
committed
doc updates around Python version and OpenAI keys
1 parent 279d0ae commit f131942

File tree

4 files changed

+10
-16
lines changed

4 files changed

+10
-16
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ export MSAL_HOST=localhost
8989
export OPENAI_API_KEY=‘<your-OpenAI-API-key>
9090
```
9191

92+
:key: Check out [OpenAI's YouTube video](https://youtu.be/nafDyRsVnXU?si=YpvyaRvhX65vtBrb) if you don't have an OpenAI API Key.
93+
9294
* In MacOS or Linux, run the following command from the Console:
9395

9496
```

docs/AI-Guide.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This guide details how to configure and tune Swirl (v. 3.0 or newer) to perform
2828
```
2929
OPENAI_API_KEY=your-key-here
3030
```
31+
*Check out [OpenAI's YouTube video](https://youtu.be/nafDyRsVnXU?si=YpvyaRvhX65vtBrb) if you don't have an OpenAI API Key.*
3132

3233
3. When installing for PRODUCTION use, change the following line in `static/api/config/default` from:
3334
```

docs/Quick-Start.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ nav_order: 2
1818

1919
This guide is intended for anyone who wants to download and install Swirl.
2020

21-
{: .warning }
22-
Version 2.5.0 of Swirl replaced RabbitMQ with Redis (`redis-server`). If you are upgrading from a previous version, please consult the [Local Installation](#local-installation) section for updated instructions or [contact support](#support).
23-
2421
{: .warning }
2522
As of version 2.6.0, Swirl's start-up process no longer starts `redis`. You must now have `redis` installed *and running* before starting Swirl.
2623

@@ -50,6 +47,9 @@ export MSAL_HOST=localhost
5047
export OPENAI_API_KEY='<your-OpenAI-API-key>'
5148
```
5249

50+
{: .highlight }
51+
Check out [OpenAI's YouTube video](https://youtu.be/nafDyRsVnXU?si=YpvyaRvhX65vtBrb) if you don't have an OpenAI API Key.
52+
5353
* On MacOS or Linux, run the following command from the Console:
5454

5555
``` shell
@@ -146,15 +146,12 @@ Using Swirl with Microsoft 365 requires installation and approval by an authoriz
146146

147147
## Prerequisites
148148

149-
{: .warning }
150-
Version 2.5.0 of Swirl replaced RabbitMQ with Redis (`redis-server`). If you are upgrading from a previous version, please note the updated instructions below or [contact support](#support).
151-
152149
{: .warning }
153150
As of version 2.6.0, Swirl's start-up process no longer starts `redis`. You must now have `redis` installed *and running* before starting Swirl.
154151

155152
### MacOS
156153

157-
* Python 3.11.5 or newer ([stable release](https://www.python.org/downloads/)) with `pip`
154+
* Python 3.11.x with `pip`
158155
* If necessary, modify the system PATH so that Python runs when you type `python` at the Terminal (not `python3`)
159156
* [venv](https://docs.python.org/3/library/venv.html) (*optional*)
160157
* [pyenv](https://github.com/pyenv/pyenv) (*optional*)
@@ -169,6 +166,9 @@ brew install jq
169166
```
170167
* Redis must be running
171168

169+
{: .warning }
170+
Swirl has not yet been validated on Python 3.12.x as some required packages have not yet completed their own 3.12.x upgrades.
171+
172172
### Linux
173173

174174
* Python 3.11.5 or newer ([stable release](https://www.python.org/downloads/)) with `pip`

docs/User-Guide.md

-9
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,6 @@ If the search page appears, click `Log Out` at the top, right. The Swirl login p
4545

4646
![Swirl Results](images/swirl_results_no_m365-galaxy_dark.png)
4747

48-
{: .warning }
49-
The Docker version of Swirl does *not* retain any data or configuration when shut down!
50-
51-
{: .highlight }
52-
Swirl includes five (5) Google Programmable Search Engines (PSEs) to get you up and running right away. The credentials for these are shared with the Swirl Community.
53-
54-
{: .highlight }
55-
Using Swirl with Microsoft 365 requires installation and approval by an authorized company Administrator. For more information, please review the [M365 Guide](M365-Guide.md) or [contact us](mailto:hello@swirl.today).
56-
5748
## Filtering Results by Source
5849

5950
![Swirl Results Source Facet](images/swirl_results_source-galaxy_dark.png)

0 commit comments

Comments
 (0)