Project docs left sidebar #264
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update template to refer to a menu defined in menus configuration named "external." Entries in the external menu will appear under a header called "project documentation." Created logic to add the new section heading Created logic to simulate page data structure for rendering in doks template logic that expects pages, not menu items Create logic to add simulated pages to the correct section Updated menus configuration to remove vestigial menu data and create a test item (cosign external docs) Signed-off-by: Patrick Smyth <[email protected]>
Resolves sigstore#250 Signed-off-by: Patrick Smyth <[email protected]>
✅ Deploy Preview for docssigstore ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ltagliaferri
reviewed
Nov 6, 2023
Signed-off-by: Patrick Smyth <[email protected]>
|
That makes sense to me. I pushed a commit to make the external docs open ina new tab. Regular docs pages should be unaffected. |
ltagliaferri
approved these changes
Nov 7, 2023
|
Seems to be working for me on the live site. Thanks, Lisa! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
This PR adds items to the left sidebar under the heading "Project Documentation." These items lead to external docs in the respective project repositories.
Implementation
Because Hugo generates the left sidebar from metadata in the content folder (one of the three main approaches to generating menus in Hugo), adding a section that leads to external sites required writing new template logic.
This PR removes vestigial menu metadata from the menus.toeml config file and adds a new menu, "external." This menu is referenced directly in the sidebar partial when building the sidebar. Because menu items created this way have a different structure from menu items created automatically (thanks, Hugo), the logic added in this PR takes menu items defined in the config and modifies them to look like automaticly generated menu items. A new section is then created, the new pages are added to the section metadata, and the new section is appended to the site's automatically generated sections.
Adding New Items
To edit the items in this new menu heading, future contributors should edit the toeml in
config/_default/menus/menus.en.toml.Notes
This PR resolves #250