Skip to content
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.

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

DOC-721 Add template for autogenerated index pages from filtered docs #236

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Dec 11, 2024

This PR introduces a new get-index-data.js helper and corresponding index-list.hbs UI template to support autogenerating index pages with links that aren't required to be in the same nav tree section (as we already have in the index.hbs` template). These additions aim to enhance the organization, navigability, and user experience of the Redpanda docs site by enabling dynamic, categorized lists of documentation pages based on configurable criteria.

These index pages:

  • Enable users to browse through categorized lists of documentation pages, enhancing their ability to find relevant information quickly.

  • Ensure that indexes remain up-to-date as new pages are added or existing ones are modified.

  • Provide a standardized layout and styling for all index pages, ensuring a cohesive look and feel across the docs site.

Here's an example of how this template will be used:

= Docker Compose Labs
:page-index-data: docker-labs-index
:page-role: index-list

Here's an example of the rendered output:
2024-12-11_16-32-57

Copy link

netlify bot commented Dec 11, 2024

Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit a560ae4
🔍 Latest deploy log https://app.netlify.com/sites/docs-ui/deploys/675ab8a92554250008c11b40
😎 Deploy Preview https://deploy-preview-236--docs-ui.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 site configuration.

@JakeSCahill JakeSCahill changed the title Add template for autogenerated index pages from filtered docs DOC-721 Add template for autogenerated index pages from filtered docs Dec 11, 2024
@JakeSCahill JakeSCahill merged commit 2cd7642 into main Dec 12, 2024
6 checks passed
@JakeSCahill JakeSCahill deleted the DOC-721 branch December 12, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants