📖 Reworking docs to breakout main README.md #254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: John Matthews <jwmatthews@gmail.com>
Signed-off-by: John Matthews <jwmatthews@gmail.com>
fabianvf
reviewed
Jul 25, 2024
docs/Getting_Started.md
Outdated
| - The primary client will be an IDE plugin | ||
| - It's also possible to issue API requests directly, and we have a python script that does this to aid demonstrations. See [example/README.md](example/README.md) | ||
|
|
||
| ## `podman compose up` |
There was a problem hiding this comment.
do you want to mention here that they can also built the image and specify it by providing the IMAGE (default quay.io/konveyor/kai and TAG envvars (default stable)?
docs/Usage.md
Outdated
|
|
||
| ## Usage Overview | ||
|
|
||
| The primary way to use Kai is via an IDE Plugin that communicates to the backend RST API. |
There was a problem hiding this comment.
Suggested change
| The primary way to use Kai is via an IDE Plugin that communicates to the backend RST API. | |
| The primary way to use Kai is via an IDE Plugin that communicates to the backend REST API. |
docs/Usage.md
Outdated
|
|
||
| [example/run_demo.py](example/run_demo.py), that will run through a migration of | ||
|
|
||
| * We have an example script that shows what usage to API looks like |
There was a problem hiding this comment.
This seems out of place/incomplete
There was a problem hiding this comment.
+1 reworking, had cruft in there
docs/Usage.md
Outdated
|
|
||
| 1. We launch VSCode with our Kai VS Code extension from [konveyor-ecosystem/kai-vscode-plugin](https://github.com/konveyor-ecosystem/kai-vscode-plugin/tree/main) | ||
| 2. We open a git checkout of a sample application: [coolstore](https://github.com/konveyor-ecosystem/coolstore) | ||
| 3. We run [Kantra](https://github.com/konveyor/kantra) inside of VSCode to do an analysis of the application to learn what issues are present that need to be addressed before migrating to Quarkus |
There was a problem hiding this comment.
maybe mention that this is something you can do from the extension
docs/contrib/Dev_Environment.md
Outdated
|
|
||
| ## Local Development | ||
|
|
||
| Running Kai's backend involves running 2 processes: |
There was a problem hiding this comment.
at least 2, the hub-importer is an optional 3rd
docs/contrib/Dev_Environment.md
Outdated
|
|
||
| Analysis data will be stored in: `samples/analysis_reports/{APP_NAME}/<initial|solved>/output.yaml` | ||
|
|
||
| ## Building a local image |
There was a problem hiding this comment.
Thanks, added more on this
Signed-off-by: John Matthews <jwmatthews@gmail.com>
Signed-off-by: John Matthews <jwmatthews@gmail.com>
jwmatthews
changed the title
jwmatthews
changed the title
Signed-off-by: John Matthews <jwmatthews@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Broke out README.md and began to expand docs in other areas.