📖 Fixed documentation (#353)

* Edited README.md Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Renamed files and merged llm_selection.md and openai_api_compatible_alternatives.md Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * More documentation updates Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Fixed broken links, edited dev_environment.md and demo.md Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Fixed formatting errors in demo_mode.md Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Standarized docs filename naming convention Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Toned down blurb Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Added terminology document Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Worked more on demo and docs Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Fixed directions in demo.md Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Changed stuff wrt demo Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Fixed nits Signed-off-by: JonahSussman <sussmanjonah@gmail.com> * Fixed nits Signed-off-by: JonahSussman <sussmanjonah@gmail.com> --------- Signed-off-by: JonahSussman <sussmanjonah@gmail.com>
konveyor · Sep 10, 2024 · 094469b · 094469b
1 parent ba4bd96
commit 094469b
Show file tree

Hide file tree

Showing 29 changed files with 1,026 additions and 600 deletions.
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -2,12 +2,12 @@
 # To learn more about the format of this file, see https://docs.trunk.io/reference/trunk-yaml
 version: 0.1
 cli:
-  version: 1.19.0
+  version: 1.22.5
 # Trunk provides extensibility via plugins. (https://docs.trunk.io/plugins)
 plugins:
   sources:
     - id: trunk
-      ref: v1.4.2
+      ref: v1.6.2
       uri: https://github.com/trunk-io/plugins
 # Many linters and tools depend on runtimes - configure them here. (https://docs.trunk.io/runtimes)
 runtimes:
@@ -24,24 +24,24 @@ lint:
         - name: lint
           run: bandit --exit-zero -c bandit.yaml --format json --output ${tmpfile} ${target}
   enabled:
-    - actionlint@1.6.26
-    - taplo@0.8.1
-    - bandit@1.7.7
-    - black@24.1.1
-    - checkov@3.2.18
+    - actionlint@1.7.1
+    - taplo@0.9.3
+    - bandit@1.7.9
+    - black@24.8.0
+    - checkov@3.2.245
     - git-diff-check
     - isort@5.13.2
-    - markdownlint@0.39.0
-    - osv-scanner@1.6.2
-    - oxipng@9.0.0
-    - prettier@3.2.5
-    - ruff@0.2.1
-    - shellcheck@0.9.0
+    - markdownlint@0.41.0
+    - osv-scanner@1.8.4
+    - oxipng@9.1.2
+    - prettier@3.3.3
+    - ruff@0.6.3
+    - shellcheck@0.10.0
     - shfmt@3.6.0
     - svgo@3.2.0
     - trivy@0.49.1
-    - trufflehog@3.67.4
-    - yamllint@1.34.0
+    - trufflehog@3.81.10
+    - yamllint@1.35.1
   ignore:
     - linters: [ALL]
       paths:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,12 +1,23 @@
 # Contributing Guide
 
-- [New Contributor Guide](#contributing-guide)
+- [Contributing Guide](#contributing-guide)
   - [Ways to Contribute](#ways-to-contribute)
+    - [Come to Meetings](#come-to-meetings)
+  - [Contact Us](#contact-us)
+    - [Slack](#slack)
+    - [Mailing list](#mailing-list)
   - [Find an Issue](#find-an-issue)
   - [Ask for Help](#ask-for-help)
   - [Pull Request Lifecycle](#pull-request-lifecycle)
+  - [Pull Request Title](#pull-request-title)
   - [Development Environment Setup](#development-environment-setup)
+  - [Linting](#linting)
+  - [Testing](#testing)
+  - [Modifying a Python Dependency](#modifying-a-python-dependency)
+  - [Running the Project](#running-the-project)
+  - [Working with Notebooks](#working-with-notebooks)
   - [Sign Your Commits](#sign-your-commits)
+    - [DCO](#dco)
   - [Pull Request Checklist](#pull-request-checklist)
 
 Welcome! We are glad that you want to contribute to our project! 💖
@@ -36,20 +47,24 @@ We welcome many different types of contributions including:
 - Release management
 
 Not everything happens through a GitHub pull request. Please come to our
-[meetings](#come-to-meetings) or [contact us](#contact-us) and let's discuss how we can work together.
+[meetings](#come-to-meetings) or [contact us](#contact-us) and let's discuss how
+we can work together.
 
 ### Come to Meetings
 
-Please consider joining the [Konveyor community meetings](https://github.com/konveyor/community?tab=readme-ov-file#konveyor-community-meetings).
+Please consider joining the [Konveyor community
+meetings](https://github.com/konveyor/community?tab=readme-ov-file#konveyor-community-meetings).
 
 Absolutely everyone is welcome to come to any of our meetings. You never need an
 invite to join us. In fact, we want you to join us, even if you don’t have
 anything you feel like you want to contribute. Just being there is enough!
 
-You can find out more about our meetings [here](https://github.com/konveyor/community?tab=readme-ov-file#konveyor-community-meetings). You don’t have to turn on
-your video. The first time you come, introducing yourself is more than enough.
-Over time, we hope that you feel comfortable voicing your opinions, giving
-feedback on others’ ideas, and even sharing your own ideas, and experiences.
+You can find out more about our meetings
+[here](https://github.com/konveyor/community?tab=readme-ov-file#konveyor-community-meetings).
+You don’t have to turn on your video. The first time you come, introducing
+yourself is more than enough. Over time, we hope that you feel comfortable
+voicing your opinions, giving feedback on others’ ideas, and even sharing your
+own ideas, and experiences.
 
 ## Contact Us
 
@@ -60,11 +75,14 @@ You can reach us in kubernetes.slack.com in :
 - [#konveyor](https://kubernetes.slack.com/archives/CR85S82A2)
 - [#konveyor-dev](https://kubernetes.slack.com/archives/C04QZJFQ0UA)
 
-If you don't already have a slack account for kubernetes.slack.com you can receive an automatic invite via: https://communityinviter.com/apps/kubernetes/community
+If you don't already have a slack account for kubernetes.slack.com you can
+receive an automatic invite via:
+https://communityinviter.com/apps/kubernetes/community
 
 ### Mailing list
 
-Subscribe to the [Konveyor emailing lists](https://groups.google.com/g/konveyor-dev
+Subscribe to the [Konveyor emailing
+lists](https://groups.google.com/g/konveyor-dev
 https://github.com/konveyor/community?tab=readme-ov-file#mailing-lists)
 
 For technical discussions please join/email:
@@ -76,14 +94,19 @@ For technical discussions please join/email:
 ## Find an Issue
 
 We have good first issues for new contributors and help wanted issues suitable
-for any contributor. [good first issue](https://github.com/konveyor/kai/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) has extra information to
-help you make your first contribution. [help wanted](https://github.com/konveyor/kai/labels/help%20wanted) are issues
-suitable for someone who isn't a core maintainer and is good to move onto after
-your first pull request.
+for any contributor.
+
+- The [good first
+  issue](https://github.com/konveyor/kai/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+  tag has extra information to help you make your first contribution.
+- The [help wanted](https://github.com/konveyor/kai/labels/help%20wanted) tag has
+  issues that are suitable for someone who isn't a core maintainer and is good to
+  move onto after your first pull request.
 
 Sometimes there won’t be any issues with these labels. That’s ok! There is
 likely still something for you to work on. If you want to contribute but you
-don’t know where to start or can't find a suitable issue, you can reach out to us in [slack](#slack)
+don’t know where to start or can't find a suitable issue, you can reach out to
+us in [slack](#slack)
 
 Once you see an issue that you'd like to work on, please post a comment saying
 that you want to work on it. Something like "I want to work on this" is fine.
@@ -99,23 +122,30 @@ The best way to reach us with a question when contributing is to ask on:
 ## Pull Request Lifecycle
 
 - Please submit pull-requests for the 'main' branch
-- Please link your PR to an existing issue, if an existing issue is not present consider creating a new issue
-- If the PR is not yet ready you may mark it as a draft, and then once it's ready for a review remove the draft status and add a comment to let us know you are ready for a review.
+- Please link your PR to an existing issue, if an existing issue is not present
+  consider creating a new issue
+- If the PR is not yet ready you may mark it as a draft, and then once it's
+  ready for a review remove the draft status and add a comment to let us know
+  you are ready for a review.
 
 ## Pull Request Title
 
-- Please ensure the title of your PR begins with a [gitemoji](https://github.com/carloscuesta/gitmoji) such as
-  - `:bug` - For bug fixes
-  - `:book` - For documentation
-  - `:sparkles` - For new features
-  - `:seedling` - For infrastructure related changes
-  - `:warning` - For breaking changes
-  - `:ghost` - For misc updates/fixes that don't need to show up in release notes
-  - For more info you can consult the pr check we run at [konveyor/release-tools](https://github.com/konveyor/release-tools/blob/main/pkg/pr/prefix.go)
+Please ensure the title of your PR begins with a
+[gitemoji](https://github.com/carloscuesta/gitmoji) such as:
+
+- `:bug:` - For bug fixes
+- `:book:` - For documentation
+- `:sparkles:` - For new features
+- `:seedling:` - For infrastructure related changes
+- `:warning:` - For breaking changes
+- `:ghost:` - For misc updates/fixes that don't need to show up in release notes
+
+For more info you can consult the pr check we run at
+[konveyor/release-tools](https://github.com/konveyor/release-tools/blob/main/pkg/pr/prefix.go)
 
 ## Development Environment Setup
 
-See [docs/contrib/Dev_Environment.md](docs/contrib/Dev_Environment.md)
+See [docs/contrib/dev_environment.md](docs/contrib/dev_environment.md)
 
 ## Linting
 
@@ -126,17 +156,19 @@ See [docs/contrib/Dev_Environment.md](docs/contrib/Dev_Environment.md)
 ## Testing
 
 - Please include a unit test for new features
-- See [docs/contrib/Testing.md](docs/contrib/Testing.md) for more guidance on testing
+- See [docs/contrib/testing.md](docs/contrib/testing.md) for more guidance on
+  testing
 
 ## Modifying a Python Dependency
 
-If you need to add or update a Python dependency in the project, follow these steps:
+If you need to add or update a Python dependency in the project, follow these
+steps:
 
-1. **Add the dependency**:
-   Open `pyproject.toml` and add the new dependency to the `dependencies` list or modify an existing one.
+1. **Add the dependency**: Open `pyproject.toml` and add the new dependency to
+   the `dependencies` list or modify an existing one.
 
-2. **Compile the requirements**:
-   Run the following commands to compile the dependencies and update the `requirements.txt` file:
+2. **Compile the requirements**: Run the following commands to compile the
+   dependencies and update the `requirements.txt` file:
 
    ```bash
       python -m venv <venv-name>
@@ -148,16 +180,21 @@ If you need to add or update a Python dependency in the project, follow these st
 
 ## Running the Project
 
-1. Setup your development environment as per [docs/contrib/Dev_Environment.md](/docs/contrib/Dev_Environment.md)
+1. Setup your development environment as per [docs/contrib/dev_environment.md](/docs/contrib/dev_environment.md)
 2. **Demo Interaction**: Read and follow [example/README.md](/example/README.md) to learn how to leverage a python script `example/run_demo.py` which will script interaction with Kai.
 
-   Running `run_demo.py` from the `example` directory is a recommended way for developers to interact with the project, allowing you to explore and test the workflow. For end users, the standard interaction will be through the IDE plugin, which provides the main interface for usage. The `run_demo.py` script is an optional method to get a feel for the project.
+   Running `run_demo.py` from the `example` directory is a recommended way for
+   developers to interact with the project, allowing you to explore and test the
+   workflow. For end users, the standard interaction will be through the IDE
+   plugin, which provides the main interface for usage. The `run_demo.py` script
+   is an optional method to get a feel for the project.
 
 For end users, please refer to the IDE plugin documentation for the primary interaction path.
 
 ## Working with Notebooks
 
-When working with Jupyter notebooks, ensure you've installed the project in editable mode `pip install -e .` to access all project modules and dependencies.
+When working with Jupyter notebooks, ensure you've installed the project in
+editable mode `pip install -e .` to access all project modules and dependencies.
 
 ## Sign Your Commits
 
@@ -202,10 +239,12 @@ before you submit your code:
 - Ensure that [trunk](https://docs.trunk.io/code-quality/advanced-setup/cli) is happy
   - `trunk check`
   - `trunk fmt`
-- Ensure that unit tests pass
-  - See [docs/contrib/Testing.md](docs/contrib/Testing.md)
+- Ensure that unit tests pass. See
+  [docs/contrib/testing.md](docs/contrib/testing.md)
 - If adding a new feature please add a new unit test
-- If you modified `requirements.txt` please see [Modifying a Python Dependency](#modifying-a-python-dependency)
+- If you modified `requirements.txt` please see [Modifying a Python
+  Dependency](#modifying-a-python-dependency)
 - Ensure that [`example/run_demo.py`](example/run_demo.py) works
 - Commits are signed as per [DCO](#dco)
-- PR Title begins with a gitemoji as described in [Pull Request Title](#pull-request-title)
+- PR Title begins with a gitemoji as described in [Pull Request
+  Title](#pull-request-title)