Fix broken docker-compose link in quick start guide#3968
Fix broken docker-compose link in quick start guide#3968kavya-seth-vns wants to merge 3 commits intoapache:mainfrom
Conversation
|
Hi maintainers, I have fixed the issue with the quick start guide for version 1.3.0. |
|
@kavya-seth-vns there is a conflict apparently. |
|
Thanks for your contribution, @kavya-seth-vns , but it looks like the same fix has already been merged in #3967 🤷 |
|
|
||
| ```bash | ||
| curl -s https://raw.githubusercontent.com/apache/polaris/refs/heads/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - up | ||
| curl -s https://raw.githubusercontent.com/apache/polaris/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - up |
There was a problem hiding this comment.
Both URLs point to the same file, but the new one is shorter, so +1 🙂
@MonkeyCanCode : WDYT?
There was a problem hiding this comment.
Actually, on a second review pass, I get the old URL for the YAML file when I browse to the "raw" file via GH UI.
With that in mind, I believe the old URL is more reliable long-term and I'd prefer to keep it (I'll remove my approval for now).
Process:
- Open https://github.com/apache/polaris/blob/main/site/content/guides/quickstart/docker-compose.yml
- Click the "raw" button
There was a problem hiding this comment.
Thanks for the clarification. The quickstart command already uses the original RAW URL for the docker-compose file, so no additional change was needed. Please let me know if you’d like me to update anything else.
Updated the command block for running quick start.
|
@kavya-seth-vns : please update the PR description. I do not think it accurately reflects the actual change anymore. |
Hi @dimas-b, I have updated the PR description to accurately reflect the current change. Please let me know if any further updates are needed. Thank you! |
|
@kavya-seth-vns : The description still claims |
|
Hi @MonkeyCanCode, |
Hello, I will check this later tonight. Thanks, |
@kavya-seth-vns thanks for the PR. As suggested by @dimas-b , we should update the description as that is not correct. This change will only update the url for unreleased and not older version (e.g. 1.3.0). Thanks, |
Thanks for the suggestion! I've updated the PR description and clarified that this change only affects the unreleased documentation. |
|
Hi @dimas-b , |
|
@kavya-seth-vns : The description still says |
|
Also, I personally think the old (longer) URL is more correct than the proposed (new) shorter URL. Cf. #3968 (comment) |
|
Hi @dimas-b, I have updated the PR description to accurately reflect the current change. Please let me know if any further updates are needed. Thank you! |
| @@ -31,10 +31,8 @@ Use this guide to quickly start running Polaris. This is not intended for produc | |||
| ## Running | |||
|
|
|||
| Run the following command: | |||
There was a problem hiding this comment.
nit: I think it's better to keep an empty line after this line.
Description
Fixes #3965
Update the docker-compose raw URL reference in the Quick Start guide.
The command in
site/content/in-dev/unreleased/getting-started/quick-start.mdwas updated to use a different raw GitHub URL path referencing the
mainbranch.curl -s https://raw.githubusercontent.com/apache/polaris/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - upBoth the old and the new URLs point to the same file. This change only updates the URL format used in the documentation.
This change only affects the unreleased documentation and does not modify documentation for older released versions such as 1.3.0.