Skip to content

Fix broken docker-compose link in quick start guide#3968

Open
kavya-seth-vns wants to merge 3 commits intoapache:mainfrom
kavya-seth-vns:fix-quickstart-docker-link
Open

Fix broken docker-compose link in quick start guide#3968
kavya-seth-vns wants to merge 3 commits intoapache:mainfrom
kavya-seth-vns:fix-quickstart-docker-link

Conversation

@kavya-seth-vns
Copy link

@kavya-seth-vns kavya-seth-vns commented Mar 10, 2026

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.md
was updated to use a different raw GitHub URL path referencing the main branch.

curl -s https://raw.githubusercontent.com/apache/polaris/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - up

Both 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.

@kavya-seth-vns
Copy link
Author

Hi maintainers, I have fixed the issue with the quick start guide for version 1.3.0.
Please review the PR when you have time. Thank you!

adutra
adutra previously approved these changes Mar 10, 2026
@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Mar 10, 2026
@adutra
Copy link
Contributor

adutra commented Mar 10, 2026

@kavya-seth-vns there is a conflict apparently.

@dimas-b
Copy link
Contributor

dimas-b commented Mar 10, 2026

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both URLs point to the same file, but the new one is shorter, so +1 🙂

@MonkeyCanCode : WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor

@dimas-b dimas-b Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dimas-b dimas-b requested a review from MonkeyCanCode March 10, 2026 14:50
Updated the command block for running quick start.
dimas-b
dimas-b previously approved these changes Mar 10, 2026
@dimas-b
Copy link
Contributor

dimas-b commented Mar 10, 2026

@kavya-seth-vns : please update the PR description. I do not think it accurately reflects the actual change anymore.

@kavya-seth-vns
Copy link
Author

@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!

@dimas-b
Copy link
Contributor

dimas-b commented Mar 11, 2026

@kavya-seth-vns : The description still claims The documentation had incorrect command formatting [...] but the actual diff replaced one valid URL with another valid URL, as far as I can tell 🤔

@kavya-seth-vns
Copy link
Author

Hi @MonkeyCanCode,
All checks are passing and the requested changes have been addressed.
Could you please take a look when you have time? Thanks!

@MonkeyCanCode
Copy link
Contributor

Hi @MonkeyCanCode,

All checks are passing and the requested changes have been addressed.

Could you please take a look when you have time? Thanks!

Hello,

I will check this later tonight.

Thanks,
Yong

@MonkeyCanCode
Copy link
Contributor

Hi @MonkeyCanCode,
All checks are passing and the requested changes have been addressed.
Could you please take a look when you have time? Thanks!

Hello,

I will check this later tonight.

Thanks, Yong

@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,
Yong

@kavya-seth-vns
Copy link
Author

Hi @MonkeyCanCode,
All checks are passing and the requested changes have been addressed.
Could you please take a look when you have time? Thanks!

Hello,
I will check this later tonight.
Thanks, Yong

@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, Yong

Thanks for the suggestion! I've updated the PR description and clarified that this change only affects the unreleased documentation.

@MonkeyCanCode MonkeyCanCode requested a review from dimas-b March 12, 2026 02:49
@kavya-seth-vns
Copy link
Author

Hi @dimas-b ,
All checks are passing and the requested changes have been addressed.
Could you please take a look when you have time? Thanks!

@dimas-b
Copy link
Contributor

dimas-b commented Mar 12, 2026

@kavya-seth-vns : The description still says Fix incorrect docker-compose raw URL in the Quick Start guide., but I do not think this is accurate. Both the old and the new URL in this PR are correct, IMHO. The only difference is in the minor URL path details in how they reference the main branch.

@dimas-b
Copy link
Contributor

dimas-b commented Mar 12, 2026

Also, I personally think the old (longer) URL is more correct than the proposed (new) shorter URL.

Cf. #3968 (comment)

@kavya-seth-vns
Copy link
Author

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think it's better to keep an empty line after this line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Quick start guide getting started 1.3.0 is broken

8 participants