-
Notifications
You must be signed in to change notification settings - Fork 488
docs: improve getting started and README documentation #2267
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.
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
Merged
dimas-b
merged 13 commits into
apache:main
from
Subham-KRLX:add-binary-distribution-doc
Nov 19, 2025
Merged
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
f3a8d9d
docs: improve getting started and README documentation
Subham-KRLX 163e595
Revert changes to getting-started/README.md as per reviewer request
Subham-KRLX 48da122
Consolidate binary setup in Getting Started index, update README quic…
Subham-KRLX 83cbb87
Update quickstart.md
Subham-KRLX 456997f
Update _index.md
Subham-KRLX 81b9ce5
Update _index.md
Subham-KRLX 74b9a5e
Update _index.md
Subham-KRLX d40b4a7
Merge upstream/main and resolve conflicts
Subham-KRLX 6219a5c
Fix binary distribution commands per reviewer feedback
Subham-KRLX 742e68f
Fix binary distribution commands per reviewer feedback
Subham-KRLX f381a4e
Remove comments from code blocks
Subham-KRLX 1fac34c
Address reviewer feedback on binary distribution docs
Subham-KRLX 9a8ca15
Refactor getting started docs
Subham-KRLX File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
|
Subham-KRLX marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| http://localhost:8181 | ||
| ``` | ||
|
|
||
| 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!* | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.