Skip to content

fix(docs): Skip empty folders in pagination & reduce PR comment noise #2853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dishaprakash merged 4 commits into from
Mar 26, 2026
Merged

fix(docs): Skip empty folders in pagination & reduce PR comment noise #2853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
672768c
docs: Skip pagination for locked folders
dishaprakash Mar 26, 2026
52955cf
Update .hugo/layouts/partials/pager.html
dishaprakash Mar 26, 2026
74fd275
gemini reviews
dishaprakash Mar 26, 2026
5471f7e
update workflow
dishaprakash Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions .github/workflows/docs_preview_deploy_cf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,34 @@ jobs:
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
command: pages deploy downloaded-artifact/public --project-name toolbox-docs --branch pr-${{ steps.get_pr.outputs.pr_number }}

- name: Comment
- name: Post Preview URL Comment
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
with:
script: |
const prNumber = parseInt('${{ steps.get_pr.outputs.pr_number }}', 10);
const deployUrl = '${{ steps.cf_deploy.outputs.pages-deployment-alias-url }}';
const marker = '<!-- cf-preview-comment-marker -->';

await github.rest.issues.createComment({
// Fetch all comments on the PR
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: prNumber,
});

// Look for the invisible HTML marker
const existingComment = comments.find(c => c.body.includes(marker));

// Exit early if we've already posted a comment for this PR to avoid duplicates
if (existingComment) {
console.log("Preview link already posted on this PR. Skipping.");
return;
}

// Create the comment since it's the first deployment for this PR
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
body: `🚀 **Cloudflare Preview Ready!**\n\n🔎 View Preview: ${deployUrl}\n\n*(Note: It may take a minute or two for Cloudflare to finish deploying the branch)*`
issue_number: prNumber,
body: `${marker}\n🚀 **Cloudflare Preview Ready!**\n\n🔎 View Preview: ${deployUrl}\n\n*(Note: Subsequent pushes to this PR will automatically update the preview at this same URL)*`
});
110 changes: 97 additions & 13 deletions .hugo/layouts/partials/pager.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
{{ $next := "" }}
{{ $prev := "" }}

{{/* 1. Calculate PREVIOUS */}}
{{ $max_skip_attempts := 5 }}

{{/* 1. Calculate Previous Page */}}
{{ if .Parent }}
{{ $siblings := .Parent.Pages.ByWeight }}
{{ $currIndex := -1 }}
Expand All @@ -14,23 +16,18 @@
{{ end }}

{{ if gt $currIndex 0 }}
{{/* Preceding sibling (if it's a folder, this naturally points to its _index.md!) */}}
{{ $prev = index $siblings (sub $currIndex 1) }}
{{ else }}
{{/* First child, so Previous points up to the Parent folder */}}
{{ if ne .Parent.Type "home" }}
{{ $prev = .Parent }}
{{ end }}
{{ end }}
{{ end }}


{{/* 2. Calculate NEXT */}}
{{/* 2. Calculate Next Page */}}
{{ if and .IsNode (gt (len .Pages) 0) }}
{{/* If it's a folder with children, Next dives into the first child */}}
{{ $next = index .Pages.ByWeight 0 }}
{{ else }}
{{/* Leaf page, or empty folder */}}
{{ if .Parent }}
{{ $siblings := .Parent.Pages.ByWeight }}
{{ $currIndex := -1 }}
Expand All @@ -42,19 +39,17 @@
{{ end }}

{{ if lt $currIndex (sub (len $siblings) 1) }}
{{/* Next sibling in the same folder */}}
{{ $next = index $siblings (add $currIndex 1) }}
{{ else }}
{{/* Last item in folder, step out and find the Parent's next sibling */}}
{{ $p := .Parent }}
{{ $foundNext := false }}

{{/* Check up to 3 directory levels up to find the next section */}}
{{ range seq 3 }}
{{ if and (not $foundNext) $p }}
{{ if $p.Parent }}
{{ $pSiblings := $p.Parent.Pages.ByWeight }}
{{ $pIndex := -1 }}

{{ range $index, $page := $pSiblings }}
{{ if eq $page.RelPermalink $p.RelPermalink }}
{{ $pIndex = $index }}
Expand All @@ -72,15 +67,105 @@
{{ end }}
{{ end }}
{{ end }}
{{ end }}
{{ end }}
{{ end }}

{{/* 3. Apply Integration Directory Filters */}}
{{ range seq $max_skip_attempts }}
{{ if $prev }}
{{ $isLockedPrev := false }}
{{ if and $prev.IsNode (in $prev.RelPermalink "/integrations/") }}
{{ if or (strings.HasSuffix $prev.RelPermalink "/tools/") (strings.HasSuffix $prev.RelPermalink "/samples/") (and $prev.Parent (strings.HasSuffix $prev.Parent.RelPermalink "/integrations/")) }}
{{ $isLockedPrev = true }}
{{ end }}
{{ end }}

{{ if $isLockedPrev }}
{{ $steppingOut := strings.HasPrefix $curr.RelPermalink $prev.RelPermalink }}

{{ if and (not $steppingOut) (gt (len $prev.Pages) 0) }}
{{ $prev = index $prev.Pages.ByWeight (sub (len $prev.Pages) 1) }}
{{ else }}
{{ if $prev.Parent }}
{{ if eq $prev.Parent.RelPermalink "/integrations/" }}
{{ $prev = $prev.Parent }}
{{ else }}
{{ $sibs := $prev.Parent.Pages.ByWeight }}
{{ $idx := -1 }}
{{ range $i, $p := $sibs }}{{ if eq $p.RelPermalink $prev.RelPermalink }}{{ $idx = $i }}{{ end }}{{ end }}

{{ if gt $idx 0 }}
{{ $prev = index $sibs (sub $idx 1) }}
{{ else }}
{{ $prev = $prev.Parent }}
{{ end }}
{{ end }}
{{ else }}
{{ $prev = "" }}
{{ end }}
{{ end }}
{{ else }}
{{ break }}
{{ end }}
{{ end }}
{{ end }}

{{ range seq $max_skip_attempts }}
{{ if $next }}
{{ $isLockedNext := false }}
{{ if and $next.IsNode (in $next.RelPermalink "/integrations/") }}
{{ if or (strings.HasSuffix $next.RelPermalink "/tools/") (strings.HasSuffix $next.RelPermalink "/samples/") (and $next.Parent (strings.HasSuffix $next.Parent.RelPermalink "/integrations/")) }}
{{ $isLockedNext = true }}
{{ end }}
{{ end }}

{{ if $isLockedNext }}
{{ if gt (len $next.Pages) 0 }}
{{ $next = index $next.Pages.ByWeight 0 }}
{{ else }}
{{ $sibs := $next.Parent.Pages.ByWeight }}
{{ $idx := -1 }}
{{ range $i, $p := $sibs }}{{ if eq $p.RelPermalink $next.RelPermalink }}{{ $idx = $i }}{{ end }}{{ end }}

{{ if lt $idx (sub (len $sibs) 1) }}
{{ $next = index $sibs (add $idx 1) }}
{{ else }}
{{ $p := $next.Parent }}
{{ $foundNextSibling := false }}

{{ range seq 3 }}
{{ if and (not $foundNextSibling) $p }}
{{ if $p.Parent }}
{{ $pSibs := $p.Parent.Pages.ByWeight }}
{{ $pIdx := -1 }}

{{ range $index, $page := $pSibs }}{{ if eq $page.RelPermalink $p.RelPermalink }}{{ $pIdx = $index }}{{ end }}{{ end }}

{{ if and (ge $pIdx 0) (lt $pIdx (sub (len $pSibs) 1)) }}
{{ $next = index $pSibs (add $pIdx 1) }}
{{ $foundNextSibling = true }}
{{ else }}
{{ $p = $p.Parent }}
{{ end }}
{{ else }}
{{ $p = false }}
{{ end }}
{{ end }}
{{ end }}

{{ if not $foundNextSibling }}{{ $next = "" }}{{ end }}
{{ end }}
{{ end }}
{{ else }}
{{ break }}
{{ end }}
{{ end }}
{{ end }}

<!-- 3. Render the Buttons -->
{{/* 4. Render Navigation */}}
{{ if or $prev $next }}
<nav class="mt-5 pt-4 border-top d-flex justify-content-between" aria-label="Page navigation">

<div>
{{ with $prev }}
<a href="{{ .RelPermalink }}" class="text-decoration-none">
Expand All @@ -98,6 +183,5 @@
</a>
{{ end }}
</div>

</nav>
{{ end }}
2 changes: 1 addition & 1 deletion docs/en/integrations/alloydb-admin/source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "AlloyDB Admin"
title: "AlloyDB Admin Source"
linkTitle: "Source"
type: docs
weight: 1
Expand Down
Loading