Publish 1.0.0 documents #1910
Publish 1.0.0 documents #1910
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR publishes the updated documentation for the Polaris 1.0.0 release, reflecting new features, deployment guides, and configuration details.
- Added new documentation pages for Polaris Spark client, management service, catalog service, metastores, and various getting-started guides.
- Introduced deployment guides for AWS, Azure, GCP and updated detailed configuration and production guidelines.
Reviewed Changes
Copilot reviewed 20 out of 28 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| site/content/in-dev/1.0.0/polaris-spark-client.md | New documentation for the Polaris Spark client. |
| site/content/in-dev/1.0.0/polaris-management-service.md | Added documentation for the Polaris Management Service. |
| site/content/in-dev/1.0.0/polaris-catalog-service.md | Added documentation for the Catalog API Spec. |
| site/content/in-dev/1.0.0/metastores.md | New documentation detailing metastores configuration and usage. |
| site/content/in-dev/1.0.0/getting-started/using-polaris.md | Guide for using Polaris via CLI and API. |
| site/content/in-dev/1.0.0/getting-started/quickstart.md | Quickstart guide for deploying Polaris locally and via Docker. |
| site/content/in-dev/1.0.0/getting-started/install-dependencies.md | Installation guide covering prerequisites. |
| site/content/in-dev/1.0.0/getting-started/deploying-polaris/quickstart-deploy-gcp.md | Deployment guide for Google Cloud Platform. |
| site/content/in-dev/1.0.0/getting-started/deploying-polaris/quickstart-deploy-azure.md | Deployment guide for Microsoft Azure. |
| site/content/in-dev/1.0.0/getting-started/deploying-polaris/quickstart-deploy-aws.md | Deployment guide for Amazon Web Services with a noted typo. |
| site/content/in-dev/1.0.0/deploying-polaris/_index.md | Index page addressing cloud provider deployments. |
| site/content/in-dev/1.0.0/getting-started/_index.md | Getting started overview page. |
| site/content/in-dev/1.0.0/generic-table.md | Documentation for Generic Table (Beta) functionality. |
| site/content/in-dev/1.0.0/evolution.md | Document describing the Polaris evolution strategy and upgrade considerations. |
| site/content/in-dev/1.0.0/entities.md | Overview of the various entities managed in Polaris. |
| site/content/in-dev/1.0.0/configuring-polaris-for-production.md | Production configuration guidelines and checklist. |
| site/content/in-dev/1.0.0/configuration.md | Detailed configuration reference for Polaris (includes a potential typo). |
| site/content/in-dev/1.0.0/admin-tool.md | Documentation for the Polaris administration tool. |
| site/content/in-dev/1.0.0/access-control.md | Comprehensive guide on access control and RBAC in Polaris. |
| site/content/in-dev/1.0.0/_index.md | Overview page for the 1.0.0 documentation set. |
| ``` | ||
|
|
||
| ## Next Steps | ||
| Congrats, you now have a running instance of1 Polaris! For details on how to use Polaris, check out the [Using Polaris]({{% relref "../using-polaris.md" %}}) page. |
There was a problem hiding this comment.
There is a typo in the message: 'instance of1 Polaris' should be corrected to 'instance of Polaris'.
| Congrats, you now have a running instance of1 Polaris! For details on how to use Polaris, check out the [Using Polaris]({{% relref "../using-polaris.md" %}}) page. | |
| Congrats, you now have a running instance of Polaris! For details on how to use Polaris, check out the [Using Polaris]({{% relref "../using-polaris.md" %}}) page. |
Copilot uses AI. Check for mistakes.
| |----------------------------------------------------------------------------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `polaris.persistence.type` | `relational-jdbc` | Define the persistence backend used by Polaris (`in-memory`, `relational-jdbc`, `eclipse-link` (deprecated)). See [Configuring Apache Polaris for Production)[{{% ref "configuring-polaris-for-production.md" %}}) | | ||
| | `polaris.persistence.relational.jdbc.max-retries` | `1` | Total number of retries JDBC persistence will attempt on connection resets or serialization failures before giving up. | | ||
| | `polaris.persistence.relational.jdbc.max_duaration_in_ms` | `5000 ms` | Max time interval (ms) since the start of a transaction when retries can be attempted. | |
There was a problem hiding this comment.
The property name 'max_duaration_in_ms' appears to contain a typo. It might be intended to be 'max_duration_in_ms'.
| | `polaris.persistence.relational.jdbc.max_duaration_in_ms` | `5000 ms` | Max time interval (ms) since the start of a transaction when retries can be attempted. | | |
| | `polaris.persistence.relational.jdbc.max_duration_in_ms` | `5000 ms` | Max time interval (ms) since the start of a transaction when retries can be attempted. | |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
copilot did a good job to find typos! We should fix it in both places.
github-project-automation
bot
moved this from PRs In Progress
to Ready to merge
in Basic Kanban Board
|
These docs will appear in the URL |
That makes sense. Considering the 0.9 doc is also in |
|
Why refactor? Just push the versioned docs to the |
|
The reason why I pushed in in-dev is because it's 0.9.x (not the release), as an active branch. I'm fine to push only 0.9.0 or release numbers in versioned-docs branch and so in /releases. |
|
The directory name is |
|
Yes agree. Just explained the initial reason. |
|
But why not doing it now right away instead of another PR? |
|
As I said at #1910 (comment). The refactor needs to cover 0.9.0 as well. The current PR is consistent with the previous behavior. I'm actually quite concern that once I made the change you suggest, someone may point out "why are you not follow the convention?". Believe or not, It happens to me a lot. |
We published the 0.9 doc after the release(#1175). Similarly, I will make this PR ready to review once 1.0 release was done.
Local test works well: