Site: clean up "Getting Started" guide with actual quickstart content#4392
Site: clean up "Getting Started" guide with actual quickstart content#4392venkateshwaracholan wants to merge 2 commits into
Conversation
venkateshwaracholan
force-pushed
the
site-quickstart-getting-started-cleanup
branch
from
a344e01 to
d4078cd
Compare
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # or more contributor license agreements. See the NOTICE file |
There was a problem hiding this comment.
nit: please avoid unecessary changes.
There was a problem hiding this comment.
Reverted the unintentional whitespace changes in the license header
|
|
||
| To stop the services: | ||
| ```bash | ||
| docker compose down |
There was a problem hiding this comment.
This command won't work I believe if not execute in the right directory.
We should inform the user that it has to run docker compose down in the directory where docker compose up has been executed.
Another approach would be to use -p polaris-quitckstart on both docker compose up and docker compose down commands.
There was a problem hiding this comment.
Used -p polaris-quickstart on all commands so down works from any directory, and added a logs command so users can still see output
| Run the following command: | ||
|
|
||
| ```bash | ||
| curl -s https://raw.githubusercontent.com/apache/polaris/refs/heads/main/site/content/guides/quickstart/docker-compose.yml | docker compose -f - up |
There was a problem hiding this comment.
This will run on foreground. Do we want this or use docker compose -d to start in background (daemon)?
There was a problem hiding this comment.
Added -d to run in background
venkateshwaracholan
force-pushed
the
site-quickstart-getting-started-cleanup
branch
from
7dbfa47 to
cf966b5
Compare
|
@jbonofre Thank you for the review! I've addressed all the comments. Could you please take another look when you get a chance? Thanks! |
github-project-automation
Bot
moved this from PRs In Progress
to Ready to merge
in Basic Kanban Board
2 participants
Addresses #3884.
The "Getting Started" guide page became sparse after #3550 moved files
around. As suggested by @adutra in the review, this PR brings the actual
quickstart content into the guide page directly, rather than redirecting
users elsewhere.
Changes:
Checklist
site/content/in-dev/unreleased(if needed)