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/02/24 17:05:22 UTC
[PR] [DRAFT] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
adutra opened a new pull request, #3876:
URL: https://github.com/apache/polaris/pull/3876
This is an attempt to add a few enhancements to the documentation section of the web site:
- Introduce a "permalink" that points to the latest stable release docs: `<roo>/releases/latest/`. This is achieved using a custom layout that generates an HTML redirect.
- Introduce a "landing page" for Documentation (it simply lists the available docs). It sits at `/docs/`.
- Improve the Documentation sidebar by displaying unreleased, active, and EOL release documentations.
- Improve the Documentation breadcrumbs by making them all start with a Documentation step, that links to the Documentation lading page.
Note: this PR requires a companion PR for the `versioned-docs` branch.
## 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] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on PR #3876:
URL: https://github.com/apache/polaris/pull/3876#issuecomment-3977219890
Summary:
- Introduce a "permalink" that points to the latest stable release docs: `<root>/releases/latest/`. This is achieved using a custom layout that generates an HTML redirect.
- Introduce a "landing page" for Documentation (it simply lists the available docs). It sits at `/docs/`.
- Improve the Documentation sidebar by displaying unreleased, active, and EOL release documentations.
- Improve the Documentation breadcrumbs by making them all start with a Documentation step, that links to the Documentation lading page.
--
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] [DRAFT] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on code in PR #3876:
URL: https://github.com/apache/polaris/pull/3876#discussion_r2848451680
##########
site/hugo.yaml:
##########
@@ -65,12 +65,11 @@ params:
# at the very right in the navbar.
active_releases:
# Mention all active releases here, in semver descending order
+ # EOL releases (0.9.0, 1.0.0) should NOT be listed here
Review Comment:
I decided rather randomly to consider 0.9.0 and 1.0.0 as "EOL" for displaying purposes, but I'm happy to put them back to the list of supported releases if that's a problem.
--
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] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra merged PR #3876:
URL: https://github.com/apache/polaris/pull/3876
--
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] [DRAFT] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
Posted by "adutra (via GitHub)" <gi...@apache.org>.
adutra commented on PR #3876:
URL: https://github.com/apache/polaris/pull/3876#issuecomment-3953547573
A few screenshots:
The new drop-down menu with the "Latest" entry:
<img width="235" height="336" alt="Screenshot 2026-02-24 at 17 55 50" src="https://github.com/user-attachments/assets/371b7c1e-73f3-4841-bc82-b48a521fe9ee" />
Documentation landing page:
<img width="1173" height="909" alt="Screenshot 2026-02-24 at 17 55 40" src="https://github.com/user-attachments/assets/4f9837d8-db66-427f-9733-df1ed57ee2e5" />
Clicking on a released version docs:
<img width="970" height="940" alt="Screenshot 2026-02-24 at 17 56 14" src="https://github.com/user-attachments/assets/f78e72e9-3889-4f59-895b-ce0ae3eedcf6" />
Clicking on the unreleased version:
<img width="955" height="769" alt="Screenshot 2026-02-24 at 17 56 04" src="https://github.com/user-attachments/assets/2c53d9b0-0649-471e-986b-1ed6a0dca339" />
--
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] [DRAFT] Add "latest" permalink and navigation sidebar to documentation pages [polaris]
Posted by "snazy (via GitHub)" <gi...@apache.org>.
snazy commented on code in PR #3876:
URL: https://github.com/apache/polaris/pull/3876#discussion_r2848756494
##########
site/content/docs/_index.md:
##########
@@ -0,0 +1,53 @@
+---
+#
+# 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.
+#
+title: 'Polaris Documentation'
+linkTitle: 'Documentation'
+type: docs
+# Mark this as the documentation root - used by breadcrumb.html partial
+params:
+ docs_root: true
+---
+
+Welcome to the Apache Polaris documentation. Select a version below to get started.
+
+## In Development
+
+The latest unreleased documentation from the main branch:
+
+- [**Unreleased**](/in-dev/unreleased/) - Latest development version
+
+## Released Versions
+
+### Active Releases
+
+These versions are currently supported:
+
+- [**1.3.0**](/releases/1.3.0/) - Latest stable release
+- [**1.2.0**](/releases/1.2.0/)
+- [**1.1.0**](/releases/1.1.0/)
+- [**1.0.1**](/releases/1.0.1/)
Review Comment:
I think, this list and the EOL list could be replaced with a shortcode. Not sure how complicated it is, so it can be done later.
##########
site/hugo.yaml:
##########
@@ -65,12 +65,11 @@ params:
# at the very right in the navbar.
active_releases:
# Mention all active releases here, in semver descending order
+ # EOL releases (0.9.0, 1.0.0) should NOT be listed here
Review Comment:
IMO even 1.0.1, 1.1.0 and 1.2.0 could be listed as EOL. We haven't settled on a policy for supported releases, so ๐คท
##########
site/layouts/_default/redirect.html:
##########
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="{{ site.Language.LanguageCode }}">
+ <head>
+ <title>{{ .Title }}</title>
+ <link rel="canonical" href="{{ .Params.redirect_to }}">
+ <meta name="robots" content="noindex">
+ <meta charset="utf-8">
+ <meta http-equiv="refresh" content="0; url={{ .Params.redirect_to }}">
Review Comment:
Ah, the good old html redirect ;)
--
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