Skip to content

Add custom sitemap template to include all pages #885

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

Jump to bottom
Merged
yi-nuo426 merged 4 commits into from
Dec 18, 2025
Merged

Add custom sitemap template to include all pages #885

yi-nuo426 merged 4 commits into from
Dec 18, 2025

Conversation

Copy link
Contributor

Copilot AI commented Dec 18, 2025 •
edited
Loading

Fix sitemap to include all individual pages

Analysis

  • Current sitemap only contained 6 section-level pages
  • Site has 223 HTML pages and 968 markdown content files
  • Issue: Hugo's default sitemap with custom [outputs] configuration only includes section pages

Solution

Created custom sitemap template at layouts/_default/sitemap.xml that uses .Site.AllPages to iterate through all published pages (excluding drafts and pages with sitemap_exclude: true frontmatter).

Changes

  • Investigate the current sitemap generation
  • Identify the root cause (default Hugo behavior with custom outputs)
  • Create custom sitemap template using .Site.AllPages
  • Build the site and verify all pages are included
  • Add *.tar.gz to .gitignore for Hugo installation files
  • Verify sitemap structure and coverage (179 URLs)
  • Revert unintended changes to README.md and LICENSE
  • Run code review
  • Run security scan

Results

Before: 6 URLs (only section pages)

  • /kanvas/
  • /charts/
  • /videos/
  • /cloud/
  • /contributing/
  • /search/

After: 179 URLs including:

  • 64 cloud pages
  • 39 kanvas pages
  • 25 videos pages
  • 34 tag pages
  • 11 category pages
  • 3 contributing pages
  • Plus charts, search, and home pages

This represents a ~30x improvement in sitemap coverage, significantly improving SEO and discoverability of all documentation pages.

Original prompt

This section details on the original issue you should resolve

<issue_title>Should the sitemap include links to all individual pages?</issue_title>
<issue_description>#### Current Behavior
Here is the Layer5 Docs website's sitemap - https://docs.layer5.io/sitemap.xml.

Desired Behavior

The current sitemap only includes a few pages. Is this intended? Would be better to have all pages included explicitly?

Contributor Guide and Resources

[!WARNING]
Before cloning this repo to your local machine, ensure that you do so sparsely or your clone will take a long time to download / sync.

Example of a sparse checkout:

git clone --filter=blob:none --sparse https://github.com/layer5labs/meshery-extensions-packages
git sparse-checkout add assets

</issue_description>

Comments on the Issue (you are @copilot in this section)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@netlify
Copy link

netlify bot commented Dec 18, 2025 •
edited
Loading

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 31589c9
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/69437b12f40c670008ea2626
😎 Deploy Preview https://deploy-preview-885--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hortison hortison marked this pull request as ready for review December 18, 2025 03:32
Copilot AI review requested due to automatic review settings December 18, 2025 03:32
Copilot AI reviewed Dec 18, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.

Copilot AI and others added 2 commits December 18, 2025 03:35
@yi-nuo426
Initial investigation: sitemap only includes 6 section pages instead …
04db9f5 
…of all 223 pages

Co-authored-by: yi-nuo426 <218099172+yi-nuo426@users.noreply.github.com>
@yi-nuo426
Fix sitemap to include all individual pages (179 URLs vs 6)
a904e46 
Co-authored-by: yi-nuo426 <218099172+yi-nuo426@users.noreply.github.com>
Copilot AI changed the title [WIP] Update sitemap to include all individual pages Add custom sitemap template to include all pages Dec 18, 2025
Copilot AI requested a review from yi-nuo426 December 18, 2025 03:41
yi-nuo426
yi-nuo426 reviewed Dec 18, 2025
View reviewed changes
README.md
Copy link
Contributor

@yi-nuo426 yi-nuo426 Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot revert all changes to the README.md file.

Copy link
Contributor Author

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted all changes to README.md in commit 31589c9. The file now contains the original Layer5 documentation content.

Copy link
Contributor Author

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted all changes to README.md in commit 31589c9.

@yi-nuo426
Copy link
Contributor

yi-nuo426 commented Dec 18, 2025

@copilot LICENSE:189 revert this change. Don't touch the LICENSE file.

yi-nuo426
yi-nuo426 reviewed Dec 18, 2025
View reviewed changes
.gitignore
Copy link
Contributor

@yi-nuo426 yi-nuo426 Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Under this change, @copilot

Copy link
Contributor Author

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your comment appears to be incomplete. Could you clarify what you'd like me to do with the .gitignore change (adding *.tar.gz)? The change was made to prevent Hugo installation tarballs from being committed to the repository.

@yi-nuo426
Revert accidental changes to README.md and LICENSE files
31589c9 
Co-authored-by: yi-nuo426 <218099172+yi-nuo426@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 18, 2025

@copilot LICENSE:189 revert this change. Don't touch the LICENSE file.

Reverted the LICENSE copyright change in commit 31589c9. Line 189 now correctly shows "Copyright 2020 Layer5, Inc." instead of the generic placeholder.

Copy link
Contributor Author

Copilot AI commented Dec 18, 2025

@copilot LICENSE:189 revert this change. Don't touch the LICENSE file.

Reverted the LICENSE copyright change in commit 31589c9. The copyright now correctly shows "Copyright 2020 Layer5, Inc."

Copilot AI requested a review from yi-nuo426 December 18, 2025 03:56
@yi-nuo426 yi-nuo426 merged commit fd27aaa into master Dec 18, 2025
6 checks passed
@yi-nuo426 yi-nuo426 deleted the copilot/update-sitemap-links branch December 18, 2025 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@yi-nuo426 yi-nuo426 Awaiting requested review from yi-nuo426

Assignees

Copilot code review Copilot

@yi-nuo426 yi-nuo426

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Should the sitemap include links to all individual pages?

2 participants

@yi-nuo426