Skip to content

Fix image links in Discovery book #9

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

Merged
merged 1 commit into from
Oct 31, 2018
Merged

Fix image links in Discovery book #9

merged 1 commit into from
Oct 31, 2018

Conversation

adamgreen
Copy link
Contributor

The links have already been fixed in the discovery repository and this PR just updates the CI scripts in the bookshelf repo to ignore the print.html link errors so that the bookshelf version will have the fixes too.

More information about the reason for the CI script change follows:

rust-lang/mdBook#789 causes
mdbook to generate print.html content with relative URLs that
are still relative to the individual HTML files and doesn't
correct for the fact that print.html isn't in the same folder.

This commit will verify that the relative URLs are correct in all
of the HTML output except for discovery/print.html I am assuming
that people would like to see the images again in the Discovery
book website as they click through the various chapters, even if
the printable version is still broken.

I have already made the same change to the CI scripts in the
discovery repository along with various link fixes.

Once this PR is merged, an issue should be created to track the
fact that this change should be reverted once mdbook handles
relative links correctly in its generaton of print.html

rust-lang/mdBook#789 causes
mdbook to generate print.html content with relative URLs that
are still relative to the individual HTML files and doesn't
correct for the fact that print.html isn't in the same folder.

This commit will verify that the relative URLs are correct in all
of the HTML output except for discovery/print.html  I am assuming
that people would like to see the images again in the Discovery
book website as they click through the various chapters, even if
the printable version is still broken.

I have already made the same change to the CI scripts in the
discovery repository along with various link fixes.

Once this PR is merged, an issue should be created to track the
fact that this change should be reverted once mdbook handles
relative links correctly in its generaton of print.html
@adamgreen
Copy link
Contributor Author

bors try

@adamgreen
Copy link
Contributor Author

The build for this repository is currently failing after the discovery repository was updated to use relative links: https://travis-ci.org/rust-embedded/bookshelf/builds/448915298

This PR will eliminate that build error. The successful Travis run for this PR can be seen here: https://travis-ci.org/rust-embedded/bookshelf/builds/448784057

Copy link
Contributor

@therealprof therealprof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks.

@therealprof therealprof merged commit aa23adc into rust-embedded:master Oct 31, 2018
@adamgreen adamgreen deleted the ignorePrintHtml branch October 31, 2018 20:18
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