Add new "partials" syntax for pegasus templates #28118
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
|
also see #28120 for an example of the kind of conversion we'd want to apply to all our markdown templates under such a scheme |
…n our file hierarchy
Hamms
changed the title
bethanyaconnor
approved these changes
Jun 13, 2019
| # | ||
| # Because such content can be translated, we want to make sure that if a | ||
| # translator accidentally translates the path to the template, we simply | ||
| # render nothing rather than throwing an error |
There was a problem hiding this comment.
It is worth tracking these errors somewhere (not sure how)? We could occasionally go through all of the invalid template paths and fix any caused by translations.
There was a problem hiding this comment.
Oh, I like that! We could probably register a honeybadger error here but still show the page. I'll add a Jira item for this.
wjordan
approved these changes
Jun 13, 2019
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.
Specifically, pegasus templates that use a rendering engine that does not have native support for partials (particularly markdown).
The implementation simply requires you to add the new extension
partialto the file, then you can include any partial within theviewsdirectory with the syntax{{ * }}, where*can be the (extensionless) name of any existing partial. The contents of the partial will be included in the template file upon render.For example, renaming
hints.mdtohints.md.partialand adding{{ testimonials }}tohints.mdresults in:Also add protection against directory transversal in our template rendering in general; we already sort of protect against this by escaping periods in URIs, but we don't currently protect against this in the existing
viewtags.