adutra commented on code in PR #3550: URL: https://github.com/apache/polaris/pull/3550#discussion_r2852417571
########## site/content/guides/quickstart/index.md: ########## @@ -17,15 +17,15 @@ # specific language governing permissions and limitations # under the License. # -linkTitle: "Guides" -title: "Apache Polaris Guides" -weight: 200 +linkTitle: "Apache Polaris" +title: "Getting Started" +weight: 10 cascade: - type: docs -# TODO remove when adding the first proposal -top_hidden: true -toc_hide: true -hide_summary: true + type: guides +menus: + main: + parent: Guides + weight: 2 --- -= Guides +Please see the [quickstart guide](../../in-dev/unreleased/getting-started) for more information. Review Comment: This guide becomes a bit "dumb" now, since it's one page on the web site, telling the user to go to another page, on the same website: <img width="1149" height="422" alt="Image" src="https://github.com/user-attachments/assets/7f81f7a0-90ee-4f7a-b76c-452b35929426"; /> As a follow-up, I think it would be nice to do things the other way around, that is: bring the contents of the quickstart example here, and have a link under `in-dev/unreleased/getting-started` pointing to here. ########## site/content/guides/_index.md: ########## @@ -0,0 +1,52 @@ +--- +# +# 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. +# +linkTitle: "Guides" +title: "Apache Polaris Guides" +weight: 200 +cascade: + type: docs +menus: + main: + parent: Guides + weight: 1 + identifier: overview + name: Overview +--- + +You can quickly get started with Polaris by playing with the docker-compose examples provided +by the guides shown on the left of this page. +Each guide has detailed instructions. + +## Prerequisites + +- [Docker](https://docs.docker.com/get-docker/) +- [Docker Compose](https://docs.docker.com/compose/install/) +- [jq](https://stedolan.github.io/jq/download/) (for some examples) + +## Getting Started Examples + +- [Spark](spark): An example that uses an in-memory metastore, automatically bootstrapped, with + Apache Spark and a Jupyter notebook. + +- [Telemetry](telemetry): An example that includes Prometheus and Jaeger to collect metrics and + traces from Apache Polaris. This example automatically creates a `polaris_demo` catalog. + +- [Keycloak](keycloak): An example that uses Keycloak as an external identity provider (IDP) for Review Comment: It seems we are missing quite a few links here (for a follow-up PR if that's better). ########## site/content/guides/README.md: ########## @@ -6,9 +6,9 @@ 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 - + Review Comment: Spurious 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
