Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Update Getting_Started.md fix typo and broken link #272

Merged
merged 2 commits into from
Aug 8, 2024
Merged

📖 Update Getting_Started.md fix typo and broken link #272

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97b0f42
Update Getting_Started.md fix typo and broken link
jwmatthews Aug 1, 2024
1707b14
Fixed more typos
JonahSussman Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/Getting_Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Steps:
1. Optional Configuration changes _ok to skip and use the defaults if using cached responses_
1. Make changes to `kai/config.toml` to select your desired provider and model
1. Export `GENAI_KEY` or `OPENAI_API_KEY` as appropriate as per [docs/LLM_Selection.md](/docs/LLM_Selection.md)
1. Note: By default the `stable` image tag will be used by podman compose.yaml. If you want to run with an alternate tag you can export the environment varaible: `TAG="stable"` with any tag you would like to use.
1. Note: By default the `stable` image tag will be used by podman compose.yaml. If you want to run with an alternate tag you can export the environment variable: `TAG="stable"` with any tag you would like to use.
1. Run `podman compose up`. The first time this is run it will take several minutes to download images and to populate sample data.
- After the first run the DB will be populated and subsequent starts will be much faster, as long as the kai_kai_db_data volume is not deleted.
- To clean up all resources run `podman compose down && podman volume rm kai_kai_db_data`.
Expand Down Expand Up @@ -73,7 +73,7 @@ _Konveyor integration is still being developed and is not yet fully integrated._

You may also run the Kai server from a python virtual environment to aid testing local changes without needing to build a container image.

- See [docs/contrib/Dev_Environment.md](docs/contrib/Dev_Environment.md)
- See [docs/contrib/Dev_Environment.md](/docs/contrib/Dev_Environment.md)

### Example CLI Script in Python

Expand All @@ -83,7 +83,7 @@ You may also run the Kai server from a python virtual environment to aid testing

### Extending the data Kai consumes

- You may modify the analysis information Kai consumes via [docs/customApps.md](docs/customApps.md)
- You may modify the analysis information Kai consumes via [docs/customApps.md](/docs/customApps.md)

### Misc notes with `podman compose`

Expand Down
Loading