Repository navigation
feat(drivercentral): a facts strip not yet uploaded is left out of the description, with a build warning - #200
Merged
Merged
Conversation
…e description, with a build warning
Contributor
There was a problem hiding this comment.
I checked the strip line as it stands in all six driver repos still on the placeholder, plus the bare <img> form two live repos use and a markdown . The new description() drops each one, keeps a real DriverCentral strip URL, and starts at <h3>Overview</h3>. Main's docs.py keeps the placeholder in all three placeholder forms (the control). I also ran make build locally on the default render, packaging included: it prints the warning once and the listing's description.html has no FACTS left in it.
This file contains hidden or 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
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.
A description whose facts strip isn't uploaded to DriverCentral yet still has
FACTS-STRIP-URLas the image'ssrc.make buildcarried that intolisting/description.html, so a paste showed a broken image at the top of the listing. Eight repos shipped that way before anyone noticed.What it does now
docs.py descriptionleaves out an image whosesrcisFACTS-STRIP-URL, with or without its<p>. A paste before the upload shows no strip instead of a broken one. Any other image is untouched.make docs-drivercentralprints a::warning::namingresources/drivercentral/description.mdwhile the placeholder is there. It shows as an annotation on the Build run, a tag build included, and tells you which file to upload and where its URL goes.Checked: the default render's render and build checks pass. Its seeded description prints the warning, and its
description.htmlstarts at the Overview. A direct run removes the placeholder in both forms and keeps a real strip URL.What reaches a driver repo
On
copier update,tools/docs.py, the Makefile and CONTRIBUTING change. It goes out with the next template tag's normal re-roll.