DOC-721 Add template for autogenerated index pages from filtered docs #236
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new
get-index-data.js
helper and correspondingindex-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:
page-index-data
refers to the name of the attribute that contains the data required to render the list on the page (an extension will handle this: DOC-721 Add extension to fetch data for index pages docs-extensions-and-macros#87).page-role
tells the UI to use theindex-list
template to render this page, effectively rendering the list of data defined inpage-index-data
.Here's an example of the rendered output:
