Skip to content

Commit d75fa71

Browse files
authored
docs: improve getting started and README documentation (#2267)
* The outdated config snippets and health-checks are removed from the index * The binary guide stays focused and concise
1 parent ceb1bbb commit d75fa71

File tree

3 files changed

+59
-14
lines changed

3 files changed

+59
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ for contribution guidelines.
4040
Click [here](https://polaris.apache.org/in-dev/unreleased/) for a quick overview of Polaris.
4141

4242
## Quickstart
43-
Click [here](https://polaris.apache.org/in-dev/unreleased/getting-started/quick-start/) for the quickstart experience.
43+
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.
4444

4545
## Project Structure
4646

site/content/in-dev/unreleased/getting-started/_index.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,16 @@ type: docs
2323
weight: 101
2424
---
2525

26-
There are several options for getting started with Apache Polaris.
26+
Welcome to Apache Polaris! This section provides several ways to get started with Polaris.
2727

28-
To quickly try out Apache Polaris, please use the [quickstart guide](./quick-start). For other examples, please see below.
28+
## Quick Start Options
2929

30-
## Docker Compose Examples
31-
Each of the proceeding Docker Compose examples provides a complete working environment with detailed instructions.
30+
Choose the method that best fits your needs:
3231

33-
### Next Steps
32+
- **[Binary Distribution]({{% relref "binary-distribution" %}})**: Download and run the pre-built binary distribution. This is the fastest way to get started with Polaris.
3433

35-
1. Check & install dependencies
36-
2. Choose the way you want to deploy Polaris
37-
3. Create a catalog
38-
4. Check Using Polaris page
34+
- **[Quickstart]({{% relref "quick-start" %}})**: Use Docker Compose to quickly start Polaris with a pre-configured setup. This is ideal for trying out Polaris without installing dependencies.
3935

40-
### Getting Help
36+
## Getting Help
4137

42-
- Documentation: https://polaris.apache.org
43-
- GitHub Issues: https://github.com/apache/polaris/issues
44-
- Slack: [Join Apache Polaris Community](https://join.slack.com/t/apache-polaris/shared_invite/zt-2y3l3r0fr-VtoW42ltir~nSzCYOrQgfw)
38+
If you need help or have questions, please refer to the [documentation]({{% relref "../../" %}}) or reach out to the community.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
Title: Binary Distribution
21+
type: docs
22+
weight: 100
23+
---
24+
Use this guide to quickly start running Polaris using the pre-built binary distribution.
25+
26+
## Prerequisites
27+
28+
- Java SE 21 or later installed on your machine
29+
30+
## Running
31+
32+
Download and extract the binary distribution:
33+
34+
```bash
35+
curl -L https://downloads.apache.org/incubator/polaris/1.0.0-incubating/polaris-bin-1.0.0-incubating.tgz | tar xz
36+
cd polaris-distribution-1.0.0-incubating
37+
```
38+
39+
Start the Polaris server:
40+
41+
```bash
42+
bin/server
43+
```
44+
45+
The server will start and listen on http://localhost:8181. Health and metrics endpoints are available under /q.
46+
47+
You can verify the server is running by checking the health endpoint:
48+
49+
```bash
50+
curl http://localhost:8181/q/health
51+
```

0 commit comments

Comments
 (0)