[DOCUMENTATION] Clarify getting started documentation regarding port number used in pre-built Docker image. #313
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
…re-built Docker image.
tgaddair
reviewed
Mar 8, 2024
README.md
Outdated
| @@ -82,6 +82,8 @@ docker run --gpus all --shm-size 1g -p 8080:80 -v $volume:/data \ | |||
| ghcr.io/predibase/lorax:latest --model-id $model | |||
| ``` | |||
|
|
|||
| Please note that the LoRAX server in our pre-built Docker image is configured to listen on port 80 (instead of on the default port number, which is 3000). | |||
There was a problem hiding this comment.
I like to keep quickstart guides very short and to the point to avoid too much cognitive load. Can we add this detail to the Docker section of the docs: https://predibase.github.io/lorax/getting_started/docker/
There was a problem hiding this comment.
@tgaddair This has been corrected, and here is how it looks in mkdocs.
Thank you.
tgaddair
approved these changes
Mar 8, 2024
tgaddair
deleted the
documentation/alexsherstinsky/getting_started/clarify_use_of_non_default_port_number_in_pre_built_docker_image-2024_03_07-0
branch
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.
What does this PR do?
Clarifies documentation: The pre-built Docker image uses port 80 (which is different than the default port of 3000).
Fixes # (issue)
Before submitting
to it if that's the case.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.