Skip to content

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

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.

Sign up for GitHub

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

Open
kavya-seth-vns wants to merge 3 commits into
base: main
Choose a base branch
from
+1 −3
Open

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29c540f
Fix broken docker-compose link in quick start guide
kavya-seth-vns Mar 10, 2026
93d4266
Merge branch 'main' into fix-quickstart-docker-link
kavya-seth-vns Mar 10, 2026
17a2b66
Fix command formatting in quick-start.md
kavya-seth-vns Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions site/content/in-dev/unreleased/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy Markdown
Member

@jbonofre jbonofre Mar 15, 2026

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.


```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
Copy Markdown
Contributor

@dimas-b dimas-b Mar 10, 2026

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

@adnanhemani adnanhemani Mar 10, 2026

Choose a reason for hiding this comment

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

+1

Copy link
Copy Markdown
Contributor

@dimas-b dimas-b Mar 11, 2026 •
edited
Loading

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
Copy Markdown
Author

@kavya-seth-vns kavya-seth-vns Mar 11, 2026

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.

```
This command will:
1. Create a Catalog named `quickstart_catalog` with RustFS-backed storage.
Expand Down
Loading