-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
UV-5 - Enhance docs #6
Conversation
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Before logging in or interacting with Cube AI, you need to make sure that Cube AI has been deployed and is running. Deployment can be done by the instance administrator or by you if you have the necessary access permissions. Therefore, to Connect: | ||
|
||
1. Ensure that Cube AI is deployed and running on your instance. | ||
2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain why this port comes from? If this is Oolama specific, then mention this. If this is ours then explain that it is user-definable through ENV and that this is just a default.
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
docs/getting-started.md
Outdated
|
||
1. Ensure that Cube AI is deployed and running on your instance. | ||
2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). | ||
3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this, not needed for the doc
Signed-off-by: JeffMboya <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What type of PR is this?
This is a documentation update
What does this do?
This PR enhances the clarity of the documentation
Which issue(s) does this PR fix/relate to?
Have you included tests for your changes?
No
Did you document any new/modified features?
No
Notes