You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@polaris.apache.org by "Subham-KRLX (via GitHub)" <gi...@apache.org> on 2025/08/05 13:42:11 UTC
[PR] docs: improve getting started and README documentation [polaris]
Subham-KRLX opened a new pull request, #2267:
URL: https://github.com/apache/polaris/pull/2267
This PR improves the documentation for Apache Polaris by enhancing the "Getting Started with Binary Distribution" guide and updating the related README file. The changes include formatting fixes, line length compliance, added code block language specifiers, and clearer, more concise instructions.
The updates ensure the documentation adheres to Markdown linting standards, improves readability, and provides a better onboarding experience for new users installing Apache Polaris using the binary distribution.
Changes:
Fixed markdownlint issues including line length and code block language specifications.
Shortened and clarified several descriptive lines to enhance readability.
Removed duplicate and redundant sections.
Verified local site build using the Hugo-based documentation generator to ensure proper formatting and rendering.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263710742
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
+
+Start the Polaris server using the provided script:
+
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, run:
+
+```bash
+./bin/polaris-server.sh stop
+```
+
+---
+
+## Additional Resources
+
+- See the official Apache Polaris documentation for details.
Review Comment:
details on what?
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
+
+Start the Polaris server using the provided script:
+
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, run:
+
+```bash
+./bin/polaris-server.sh stop
+```
+
+---
+
+## Additional Resources
+
+- See the official Apache Polaris documentation for details.
+- Use ./bin/polaris-admin in the binary for admin and maintenance tasks.
+
+---
+
+Get started with Apache Polaris binaries. See repo for containers and more.
+
+---
+
+*Happy data cataloging with Apache Polaris!*
+
+---
Review Comment:
We can cut this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2256657870
##########
getting-started/getting-started-binary.md:
##########
@@ -0,0 +1,119 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+apache-polaris-<version>-bin.tar.gz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+tar -xzvf apache-polaris-<version>-bin.tar.gz
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the configuration file if needed:
Review Comment:
Missing a small example here?
##########
getting-started/getting-started-binary.md:
##########
@@ -0,0 +1,119 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+apache-polaris-<version>-bin.tar.gz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+tar -xzvf apache-polaris-<version>-bin.tar.gz
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the configuration file if needed:
+
+---
+
+## Step 4: Run the Polaris Server
+
+Start the Polaris server using the provided script:
+
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
Review Comment:
Not sure a browser is the best option, Polaris doesn't have a web UI (yet). Maybe `curl`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2284199353
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
index page is completely fine to me. In a lot cases, it is preferable. For example, the "Overview page", otherwise, the first page loaded is en empty one, which forces reader to do one more click to view a real page.
What's the concern of using the index page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263489506
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,115 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
Review Comment:
this command will extract the tarball, either we remove `| tar xz` in this line, or remove line 61
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2530093391
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,110 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server using the provided script:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, run:
+
+```bash
+./bin/polaris-server.sh stop
Review Comment:
Same here
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2530093313
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,110 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server using the provided script:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+./bin/polaris-server.sh start
Review Comment:
there is no such file `./bin/polaris-server.sh`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3161757943
Looking a bit more, I think it makes more sense to have it in this page, https://github.com/apache/polaris/blob/af69d9f9699d8a0cae1b70839e1b5c1bfc9ba511/site/content/in-dev/unreleased/getting-started/_index.md. So that every time, people click "Getting Started", the index page shows up and provide instructions for binary package usage, which probably the fastest way to set up a Polaris server.
One more thing we could add into the index page is the link to this page, https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/, which shows how to start from the source code.
And we can change the link in this line https://github.com/apache/polaris/blob/04e65af4f8052459b8bea04f6274684278c3660a/README.md?plain=1#L43 to the index page.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263690392
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
Review Comment:
We actually combine two steps as a single command handles both download and exacting. Let's remove this step. The `cd` part can go to next step.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3553579462
This PR had a lot of work and feedback. I'm merging now. If there are additional comments, follow-up doc changes are always welcome.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2285506523
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
side note: the `_` prefix in `_index.md` also make the impression that it's a technical page rather than "content" page.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2267984462
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
Is `_index.md` the right place for adding content? There is apparently an existing pattern for adding `.md` files per sub-section under the `getting-started` directory.
Also, note the `render: never` setting above... Is that a concern?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263651478
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
It points the index page in that directory. I don't think it's wrong.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3172303903
@flyrain,My local build fails in the polaris-admin test phase with the message: “The Agroal dependency is present but no JDBC datasources have been defined.” Since my PR only updates documentation this seems unrelated to my changes. Is this a test environment issue or do I need to configure a test datasource? Please advise.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3168858587
I think it's good to go now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2264210441
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
Linking to the [Getting Started index page](https://polaris.apache.org/in-dev/unreleased/getting-started/) is intentional to surface the new binary package docs first in the quickstart flow. The index is the entry point for both binary and source setup making navigation simpler. We can revisit this if the doc structure changes but for now I will keep it as is.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3545665034
Hey everyone thanks so much for the detailed feedback. I’ve moved the tar based instructions over to a
new binary-distribution.md page (which now runs in parallel with quick-start.md). also simplified
getting-started/_index.md into a clean landing page that directs people to both options.
With this update:
- The outdated config snippets and health-checks are removed from the index
- The binary guide stays focused and concise
- The structure aligns with the suggestions from the reviewers
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2532337694
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
Review Comment:
Nit: the separator may not be quite helpful for a small section like this. Could we remove all of them?
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Configure Polaris using environment variables or system properties. For example:
+
+```bash
+export POLARIS_JAVA_OPTS="-Dpolaris.storage.backend=local -Dpolaris.storage.local.path=/data/polaris"
Review Comment:
these two options don't exist
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
Review Comment:
please remove this step as step 1 extract it already.
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Configure Polaris using environment variables or system properties. For example:
+
+```bash
+export POLARIS_JAVA_OPTS="-Dpolaris.storage.backend=local -Dpolaris.storage.local.path=/data/polaris"
+```
+
+Alternatively, you can set options when starting the server in Step 4.
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+bin/server
+```
+
+The server will start on `http://localhost:8181` by default.
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, use `Ctrl+C` in the terminal where it's running, or kill the process:
+
+```bash
+pkill -f "java.*quarkus-run.jar"
+```
+
+---
+
+## Additional Resources
+
+- See the [official Apache Polaris documentation](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage.
+- Use `bin/admin` in the binary distribution for administrative and maintenance tasks (e.g., `bin/admin bootstrap`, `bin/admin purge`).
Review Comment:
I'd suggest to take a look at https://github.com/apache/polaris/blob/main/runtime/distribution/README.md for more context.
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Configure Polaris using environment variables or system properties. For example:
+
+```bash
+export POLARIS_JAVA_OPTS="-Dpolaris.storage.backend=local -Dpolaris.storage.local.path=/data/polaris"
+```
+
+Alternatively, you can set options when starting the server in Step 4.
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+bin/server
+```
+
+The server will start on `http://localhost:8181` by default.
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, use `Ctrl+C` in the terminal where it's running, or kill the process:
+
+```bash
+pkill -f "java.*quarkus-run.jar"
+```
+
+---
+
+## Additional Resources
+
+- See the [official Apache Polaris documentation](https://polaris.apache.org/docs/) for comprehensive information on configuration, deployment, and usage.
Review Comment:
we may not need to mention it, as people visiting this page are already here.
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Configure Polaris using environment variables or system properties. For example:
+
+```bash
+export POLARIS_JAVA_OPTS="-Dpolaris.storage.backend=local -Dpolaris.storage.local.path=/data/polaris"
+```
+
+Alternatively, you can set options when starting the server in Step 4.
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+bin/server
+```
+
+The server will start on `http://localhost:8181` by default.
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
Review Comment:
I think the path is wrong.
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
Review Comment:
I'd suggest to point people to this page, https://polaris.apache.org/downloads/.
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,105 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
Review Comment:
we could move this to next step `configure Polaris`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263594517
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
This looks wrong, why are we not linking to a page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263707593
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
The previous version seems correct to me, that is the first page in the getting started flow. Why would we link users [here](https://polaris.apache.org/in-dev/unreleased/getting-started/)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3176823645
> @flyrain,My local build fails in the polaris-admin test phase with the message: “The Agroal dependency is present but no JDBC datasources have been defined.” Since my PR only updates documentation this seems unrelated to my changes. Is this a test environment issue or do I need to configure a test datasource? Please advise.
Reopen it to trigger the CI
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain closed pull request #2267: docs: improve getting started and README documentation
URL: https://github.com/apache/polaris/pull/2267
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3160689157
@flyrain, Could you please specify where exactly to add the binary distribution instructions in the Quickstart page? Should it be a separate section after “Running Polaris as a Standalone Process” including all steps like prerequisites ,download, configuration, start, verify, and stop? Also what title do you prefer for the section? I want to ensure the update aligns perfectly with your expectations before proceeding.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2268410848
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
So should i change this or what All tests are green should I proceed with this change ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263709602
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
Review Comment:
The docs are versioned, so we should just put the actual version here
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
Review Comment:
This is not necessary
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2280220441
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
@snazy @flyrain @jbonofre : WDYT about adding content to `_index.md`? It does not look like the right place to me (I'd think a new file would be appropriate), but I'm not very familiar with Hugo-based doc conventions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2535007336
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -6,39 +6,109 @@
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-title: Getting Started with Apache Polaris
Review Comment:
Thanks for pointing this out!
This change was unintentional it likely resulted from my editor auto formatting while I was restructuring the section. It doesn’t serve any purpose so I’ll revert it in the next commit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2267984462
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
Is `_index.md` the right place for adding content? There is apparently an existing pattern for added `.md` files per sub-section under the `getting-started` directory.
Also, note the `render: never` setting above... Is that a concern?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3166154691
I will fix it but it will take some time as I am currently busy with my exams.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263709048
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
Is the intent to hard-link to the new index page instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263716524
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
yup, that's the intention. That's one way to get the binary package doc visible. There could be other ways, we can always refactor doc later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2267970204
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
Review Comment:
I think we still need to resolve this comment, as we have combined step1 and step 2.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2285504286
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
From my POV the concern is `render: never` , but I do not know why it was set.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3162482528
I think now its good to go.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3160280381
Give me some time; I will fix everything that is necessary.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2280220441
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
@snazy @flyrain @jbonofre : WDYT about adding content to `_index.md`? I do not look like the right place to me (I'd think a new file would be appropriate), but I'm not very familiar with Hugo-based doc conventions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2531062387
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,110 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
-### Next Steps
+Start the Polaris server using the provided script:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+./bin/polaris-server.sh start
Review Comment:
Removed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2530092949
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,19 +23,110 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+# Getting Started with Apache Polaris Binary Distribution
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
+```
+
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
Review Comment:
the binary distribution doesn't come with the file by default. Users have to either create one, or use the env variables.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b merged PR #2267:
URL: https://github.com/apache/polaris/pull/2267
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2260746999
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,117 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+apache-polaris-<version>-bin.tar.gz
Review Comment:
Minor: Can we provide a more detailed instruction like this?
```
curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz
```
or we can combine step 1 and 2 into one command like
```
curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263615659
##########
README.md:
##########
@@ -40,7 +40,7 @@ for contribution guidelines.
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
## Quickstart
-Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/install-dependencies/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
+Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/) for the quickstart experience, which will help you set up a Polaris instance locally or on any supported cloud provider.
Review Comment:
Thank you for pointing that out Would you recommend that I revert the link to the previous version or should I update it differently to ensure it points to a proper page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263711802
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
+
+Start the Polaris server using the provided script:
+
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, run:
+
+```bash
+./bin/polaris-server.sh stop
+```
+
+---
+
+## Additional Resources
+
+- See the official Apache Polaris documentation for details.
+- Use ./bin/polaris-admin in the binary for admin and maintenance tasks.
+
+---
+
+Get started with Apache Polaris binaries. See repo for containers and more.
+
+---
+
+*Happy data cataloging with Apache Polaris!*
+
+---
+
+**Want to build or run Polaris from source?**
+See the [Quickstart guide](https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/) for developer instructions and advanced setup.
Review Comment:
Should this be folded in with the `see repo` section?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2263710380
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,114 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
+
+Quickly start Apache Polaris by running the pre-built binary, no build needed.
+
+---
+
+## Prerequisites
+
+- Java 21 or later installed. You can verify this by running:
+
+```bash
+java -version
+```
+
+- Basic familiarity with running commands in your operating system terminal.
+
+---
+
+## Step 1: Download the Apache Polaris Binary
+
+1. Visit the official Apache Polaris GitHub
+ [Releases page](https://github.com/apache/polaris/releases).
+
+2. Download the latest binary archive file, for example:
+
+```bash
+curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz```
+---
+
+## Step 2: Extract the Archive
+
+Extract the downloaded tar.gz file to your desired directory:
+
+```bash
+cd apache-polaris-<version>
+```
+
+*Replace `<version>` with the actual version number.*
+
+---
+
+## Step 3: Configure Polaris (Optional)
+
+Edit the `application.properties` file if needed. For example:
+
+```bash
+polaris.storage.backend=local
+polaris.storage.local.path=/data/polaris
+```
+*(This is a configuration file, not a shell command. Adjust these values as needed.)*
+
+---
+
+## Step 4: Run the Polaris Server
+
+Start the Polaris server using the provided script:
+
+```bash
+./bin/polaris-server.sh start
+```
+
+To tail the logs in a separate terminal, run:
+
+```bash
+tail -f logs/polaris.log
+```
+
+---
+
+## Step 5: Verify the Server is Running
+
+Open your browser and navigate to:
+
+```bash
+curl http://localhost:8181/api/catalog/v1/health
+```
+
+You should see the Polaris server running or be able to access its REST API.
+
+---
+
+## Step 6: Stop the Polaris Server
+
+To stop the server, run:
+
+```bash
+./bin/polaris-server.sh stop
+```
+
+---
+
+## Additional Resources
+
+- See the official Apache Polaris documentation for details.
+- Use ./bin/polaris-admin in the binary for admin and maintenance tasks.
+
+---
+
+Get started with Apache Polaris binaries. See repo for containers and more.
Review Comment:
Let's remove this or add a link
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3193357369
If this PR is fixed please feel free to merge it. If not kindly provide the corrections I need to make so I can start working on the issue assigned to me and raise a PR regarding that issue.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "snazy (via GitHub)" <gi...@apache.org>.
snazy commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2282242394
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,3 +23,101 @@ weight: 101
build:
render: never
---
+
+# Getting Started with Apache Polaris Binary Distribution
Review Comment:
There's technically nothing wrong w/ content in that file.
However, with `render: never` it will never appear.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2534976184
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -6,39 +6,109 @@
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-title: Getting Started with Apache Polaris
Review Comment:
why this change? 🤔
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "dimas-b (via GitHub)" <gi...@apache.org>.
dimas-b commented on code in PR #2267:
URL: https://github.com/apache/polaris/pull/2267#discussion_r2534647310
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,22 +23,83 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+This guide will help you get started with Apache Polaris using the binary distribution, which is the fastest way to set up a Polaris server.
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+## Prerequisites
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+Before you begin, ensure you have the following:
-### Next Steps
+- Java SE 21 or higher installed
+- Verify Java installation:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+java -version
+```
-### Getting Help
+## Step 1: Download and Extract the Binary Distribution
-- Documentation: https://polaris.apache.org
-- GitHub Issues: https://github.com/apache/polaris/issues
-- Slack: [Join Apache Polaris Community](https://join.slack.com/t/apache-polaris/shared_invite/zt-2y3l3r0fr-VtoW42ltir~nSzCYOrQgfw)
+1. Visit the [Apache Polaris downloads page](https://polaris.apache.org/downloads/).
+
+2. Download the latest binary distribution (tar.gz file) and extract it to your desired directory:
+
+```bash
+tar -xzf apache-polaris-1.0.0-incubating-bin.tar.gz
+```
+
+## Step 2: Configure Polaris
+
+Navigate to the extracted directory:
+
+```bash
+cd apache-polaris-1.0.0-incubating-bin
+```
+
+Configure Polaris using environment variables or system properties. For example:
+
+```bash
+export POLARIS_JAVA_OPTS="-Dquarkus.http.port=8080"
+export POLARIS_JAVA_OPTS="-Dpolaris.persistence.type=relational-jdbc"
+export POLARIS_JAVA_OPTS="-Xms512m -Xmx1g -Dquarkus.http.port=8080"
Review Comment:
Each line overwrites the previous setting, does it not? Is that intended? It could be confusing to users 🤔
##########
site/content/in-dev/unreleased/getting-started/_index.md:
##########
@@ -23,22 +23,83 @@ type: docs
weight: 101
---
-There are several options for getting started with Apache Polaris.
+This guide will help you get started with Apache Polaris using the binary distribution, which is the fastest way to set up a Polaris server.
-To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
+## Prerequisites
-## Docker Compose Examples
-Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
+Before you begin, ensure you have the following:
-### Next Steps
+- Java SE 21 or higher installed
+- Verify Java installation:
-1. Check & install dependencies
-2. Choose the way you want to deploy Polaris
-3. Create a catalog
-4. Check Using Polaris page
+```bash
+java -version
+```
-### Getting Help
+## Step 1: Download and Extract the Binary Distribution
Review Comment:
We have this (based on tar) and https://polaris.apache.org/in-dev/unreleased/getting-started/quick-start/ (based on docker). Would it make sense to move this section into a sub-page parallel to the docker-compose example?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: improve getting started and README documentation [polaris]
Posted by "Subham-KRLX (via GitHub)" <gi...@apache.org>.
Subham-KRLX commented on PR #2267:
URL: https://github.com/apache/polaris/pull/2267#issuecomment-3172285076
The Quarkus tests in polaris-runtime-service are failing with Agroal dependency is present but no JDBC datasources have been defined. Could you clarify if this modules tests require an actual JDBC configuration or if Agroal shouldn’t be loaded at all in this context? Also should we configure an in-memory datasource for CI runs?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org