You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@polaris.apache.org by "adutra (via GitHub)" <gi...@apache.org> on 2026/08/19 13:46:57 UTC
[PR] Replace manual guides list with automatically generated one [polaris]
adutra opened a new pull request, #5334:
URL: https://github.com/apache/polaris/pull/5334
<!--
📝 Describe what changes you're proposing, especially breaking or user-facing changes.
📖 See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more.
-->
## Checklist
- [ ] 🛡️ Don't disclose security issues! (contact security@apache.org)
- [ ] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
- [ ] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
- [ ] 💡 Added comments for complex logic
- [ ] 🧾 Updated `CHANGELOG.md` (if needed)
- [ ] 📚 Updated documentation in `site/content/in-dev/unreleased` (if needed)
--
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] Replace manual guides list with automatically generated one [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #5334:
URL: https://github.com/apache/polaris/pull/5334#discussion_r3821950664
##########
site/layouts/shortcodes/guides-list.html:
##########
@@ -0,0 +1,26 @@
+{{/*
+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.
+*/}}
+<ul>
+{{ range .Page.Pages.ByWeight -}}
Review Comment:
I don't think it's worth the complexity.
--
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] Replace manual guides list with automatically generated one [polaris]
Posted by "flyrain (via GitHub)" <gi...@apache.org>.
flyrain commented on code in PR #5334:
URL: https://github.com/apache/polaris/pull/5334#discussion_r3825945579
##########
site/content/guides/rustfs/index.md:
##########
@@ -19,6 +19,7 @@
#
linkTitle: "Storage: RustFS"
title: "Getting Started with Apache Polaris and RustFS"
+description: "Uses RustFS for S3-compatible object storage and Apache Flink as the stream processing engine."
Review Comment:
this guide doesn't use Flink. The body says "Spark is used as a query engine" (line 43) and neither the guide nor `rustfs/docker-compose.yml` mentions Flink. Can we switch it to Spark?
##########
site/content/guides/quickstart/index.md:
##########
@@ -19,6 +19,7 @@
#
linkTitle: "Quickstart"
title: "Quickstart"
+description: "A minimal quickstart example that uses an in-memory metastore, automatically bootstrapped."
Review Comment:
Nit: The quickstart compose also starts RustFS (`quickstart/docker-compose.yml:23`, and the body says "start Polaris + RustFS"), but the description only mentions the in-memory metastore. Can we name the storage here too?
--
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] Replace manual guides list with automatically generated one [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #5334:
URL: https://github.com/apache/polaris/pull/5334#discussion_r3821948638
##########
site/content/guides/_index.md:
##########
@@ -42,20 +42,7 @@ Each guide has detailed instructions.
## Getting Started Examples
Review Comment:
I don't think we should include this, as this instruction is for developers updating the site, not for readers of the site.
--
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] Replace manual guides list with automatically generated one [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra merged PR #5334:
URL: https://github.com/apache/polaris/pull/5334
--
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] Replace manual guides list with automatically generated one [polaris]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #5334:
URL: https://github.com/apache/polaris/pull/5334#discussion_r3813676500
##########
site/layouts/shortcodes/guides-list.html:
##########
@@ -0,0 +1,26 @@
+{{/*
+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.
+*/}}
+<ul>
+{{ range .Page.Pages.ByWeight -}}
Review Comment:
Sorting only by weight can lead to unstable/opaque ordering when multiple pages share the same `weight` (several guides appear to have the same value). Consider adding a deterministic tie-breaker (e.g., chain a secondary sort like link title) so the rendered ordering doesn’t depend on filesystem or build nuances.
##########
site/layouts/shortcodes/guides-list.html:
##########
@@ -0,0 +1,26 @@
+{{/*
+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.
+*/}}
+<ul>
+{{ range .Page.Pages.ByWeight -}}
+{{ $page := . -}}
+{{ with .Params.description -}}
+<li><a href="{{ $page.RelPermalink }}">{{ $page.LinkTitle }}</a>: {{ . }}</li>
+{{ end -}}
+{{ end -}}
Review Comment:
The list only renders items for pages that define `Params.description` because the `<li>` is inside a `with` block. That means any guide missing `description` will silently disappear from the list. Consider always rendering the `<li>` and making the description optional (or using Hugo’s `$page.Description` as a fallback, which can come from front matter or summary).
##########
site/content/guides/_index.md:
##########
@@ -42,20 +42,7 @@ Each guide has detailed instructions.
## Getting Started Examples
Review Comment:
Now that the list is generated by shortcode logic (ordering by weight and potentially requiring `description`), it would help readers/authors if this section briefly stated what controls ordering and what metadata is required for inclusion. Otherwise, missing descriptions/weights can make guides appear to ‘vanish’ with no obvious reason.
--
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