Upgrades for mdbook 0.2.0, and link style cleanup. #391

alercah · 2018-08-07T08:57:15Z

See individual commit messages for description of what I did.

I have not verified all links. mdbook-linkcheck does not yet support 0.2.0.

Havvy

A few nits and questions.

src/expressions/array-expr.md

src/items/traits.md

src/items/type-aliases.md

src/items/unions.md

src/expressions.md

src/items.md

src/types.md

Havvy · 2018-08-09T05:06:45Z

Oh, I commented on commits as I checked on each commit. Thus some stuff says out of date even though it's not.

Havvy · 2018-09-20T22:48:55Z

This needs to be rebased pretty badly. I think it'd be easier if the alphabetizing commit was its own PR.

alercah · 2019-01-27T21:38:47Z

Rebased and updated, removed the sorting/organization and just stuck on the version upgrade.

alercah · 2019-01-27T21:39:00Z

@steveklabnik

ehuss · 2019-01-28T00:34:18Z

These links don't look correct to me. They should all be relative to the page they are on. For example, introduction.md has a bunch of ../ links that should not have ../. If you visit the page here on Github, none of the links are working.

There also looks to be some unintended changes to // comments in operator-expr.md.

ehuss · 2019-01-28T00:54:58Z

Oh, .travis.yml will need to be updated, too.

steveklabnik · 2019-01-28T15:44:47Z

I'm running linkcheck on this right now, but I suspect @ehuss is correct.

steveklabnik · 2019-01-28T15:58:04Z

Oh shucks, it looks like the upstream PR for multi-mdbook support has not actually landed. I thought it had. Let me take care of that ASAP.

steveklabnik · 2019-01-28T15:59:05Z

Now r+'d rust-lang/rust#57495

alercah · 2019-01-29T15:33:55Z

@ehuss Ah right, I thought I reverted all the ones outside of subdirs since I did them by mistake, but missed introduction.md. I fixed some I missed too that linkcheck found.

ehuss

All of the links to .html in-repo need to be updated to .md. This allows links to work on GitHub, and mdbook doesn't handle the .html links properly in the print page (all links not in the root are currently broken on the print page).

src/expressions/array-expr.md

ehuss · 2019-01-29T16:30:53Z

.travis.yml

@@ -4,7 +4,7 @@ rust:
  - nightly

 install:
-  - travis_retry curl -Lf https://github.com/rust-lang-nursery/mdBook/releases/download/v0.1.7/mdbook-v0.1.7-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=$HOME/.cargo/bin
+  - travis_retry curl -Lf https://github.com/rust-lang-nursery/mdBook/releases/download/v0.2.1/mdbook-v0.2.1-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=$HOME/.cargo/bin


Oh, hmm, this needs to be 0.2.3. @steveklabnik would it be possible to publish a binary for the latest release on github?

I don't know how to do this. @Michael-F-Bryan ?

steveklabnik · 2019-01-29T18:26:40Z

So, I have good news, and I have bad news. Good news is, I ran this against upstream's linkchecker. Bad news is that I got:

reference\expressions\array-expr.html:225: broken link - reference\std\ops\trait.Index.html
reference\expressions\array-expr.html:225: broken link - reference\std\ops\trait.IndexMut.html
reference\print.html:2243: broken link - identifiers.html
reference\print.html:2244: broken link - identifiers.html
reference\print.html:2245: broken link - attributes.html
reference\print.html:2246: broken link - items.html
reference\print.html:2249: broken link - items.html
reference\print.html:2280: broken link - paths.html
reference\print.html:2345: broken link - crates-and-source-files.html
reference\print.html:2347: broken link - crates-and-source-files.html
reference\print.html:2348: broken link - attributes.html
reference\print.html:2353: broken link - conditional-compilation.html
reference\print.html:2354: broken link - attributes.html
reference\print.html:2354: broken link - attributes.html
reference\print.html:2354: broken link - attributes.html
reference\print.html:2362: broken link - identifiers.html
reference\print.html:2364: broken link - identifiers.html
reference\print.html:2367: broken link - identifiers.html
reference\print.html:2376: broken link - identifiers.html
reference\print.html:2400: broken link - crates-and-source-files.html
reference\print.html:2401: broken link - items\modules.html
reference\print.html:2405: broken link - items\use-declarations.html
reference\print.html:2407: broken link - items\use-declarations.html
reference\print.html:2432: broken link - attributes.html
reference\print.html:2440: broken link - paths.html
reference\print.html:2441: broken link - paths.html
reference\print.html:2442: broken link - paths.html
reference\print.html:2442: broken link - identifiers.html

reference\print.html:6145: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.Fn.html
reference\print.html:6145: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnMut.html
reference\print.html:6146: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnOnce.html

reference\print.html:8032: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.Fn.html
reference\print.html:8032: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnMut.html
reference\print.html:8032: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnOnce.html
reference\print.html:8032: broken link - special-types-and-traits.html
reference\print.html:8033: broken link - special-types-and-traits.html
reference\print.html:8033: broken link - special-types-and-traits.html
reference\print.html:8033: broken link - special-types-and-traits.html
reference\print.html:8035: broken link - expressions\closure-expr.html
reference\print.html:8134: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnOnce.html
reference\print.html:8140: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnMut.html
reference\print.html:8144: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.Fn.html
reference\print.html:8148: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.Fn.html
reference\print.html:8148: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\ops\trait.FnMut.html

reference\print.html:7914: broken link - C:\Users\steve\src\jamesrust\build\x86_64-pc-windows-msvc\std\vec\struct.Vec.html

... and more, but I won't paste the same line about print.html over and over again...

I am very confused about print.html, because I did rust-lang/mdBook#866 to fix this.

steveklabnik · 2019-01-29T18:31:06Z

All of the links to .html in-repo need to be updated to .md. This allows links to work on GitHub, and mdbook doesn't handle the .html links properly in the print page (all links not in the root are currently broken on the print page).

ahhhhhh yes

steveklabnik · 2019-01-30T19:12:42Z

The upstream PR has landed! @alercah let me know when you want me to try the linkchecker again :)

mdbook 0.2.0 says that src/theme was accepted in error.

alercah · 2019-02-02T17:50:18Z

Apologies for the delay here, had some issues. Should be good to go now, though I can't get linkcheck to ignore the parent directories so I can't be totally sure.

ehuss · 2019-02-02T20:13:28Z

Hm, something's wrong. I swore I tested the print page on 0.2.3, but there are still problems. There are two issues:

Links like items/unions.md jump out of the print page. I would assume the 0.1 behavior should be retained where the print page links to itself.
Links like ../../std/mem/fn.discriminant.html are not rebased when used from a subdirectory, and are broken.

I'll see if I can figure out what's wrong in the next few days.

ehuss · 2019-02-03T23:50:12Z

I have posted a proposed fix for the print.html links at rust-lang/mdBook#871.

As for publishing 0.2.3, it looks like the deploy scripts are broken (travis and appveyor). I have posted a partial fix for Travis at rust-lang/mdBook#872. The API keys need to be fixed since the transition to travis.com. @steveklabnik if you have permissions, can you take care of that? Or if not, I can try to bug infra and get things worked out. Alternatively the releases can be made manually (it's just a compressed copy of the mdbook executable), and uploaded manually on the GitHub releases page.

mati865 · 2019-07-07T15:07:35Z

There is mdbook 0.3 so this should be unblocked but there are so many conflicts and new links this PR probably has to be redone from scratch.

ehuss · 2019-07-07T15:12:29Z

@mati865 There was another bug blocking the update of the reference and cargo (rust-lang/mdBook#963). It is now fixed, I just need to make a new release. I'll be posting a new PR here to replace this one when things are ready. It will require a coordinated update due to some changes to anchor tags. I think I'll be able to eradicate 0.1 during that update.

ehuss · 2019-07-16T21:47:30Z

I'm going to close this for now. The reference has been updated to mdbook 0.3 in #641. If there are any link cleanups we want to do, we can always do them in future PRs. Thanks @alercah, sorry it took so long to iron out all the kinks in mdbook to make this work.

alercah requested a review from Havvy August 7, 2018 08:57

Havvy requested changes Aug 9, 2018

View reviewed changes

Havvy added the Enhancement Improvement in a non-prose section of the book label Aug 15, 2018

This was referenced Aug 18, 2018

mdbook 0.2.0 rust-docs/team#23

Open

Expand documentation on procedural macros #405

Closed

alercah force-pushed the upgrade branch from 6a01738 to 198488b Compare January 27, 2019 21:36

alercah force-pushed the upgrade branch from 198488b to 8c299a1 Compare January 29, 2019 15:34

ehuss requested changes Jan 29, 2019

View reviewed changes

src/expressions/array-expr.md Outdated Show resolved Hide resolved

ehuss reviewed Jan 29, 2019

View reviewed changes

alercah force-pushed the upgrade branch from 8c299a1 to 0444157 Compare February 2, 2019 17:45

Alexis Hunt added 5 commits February 2, 2019 12:48

Move src/theme to theme

81a2299

mdbook 0.2.0 says that src/theme was accepted in error.

Update links in nested directories.

1492a9b

Add vim temporary files to gitignore.

fb62482

Update travis build to use 2.X

6629f76

Update internal links to use .md, not .html.

a852878

alercah force-pushed the upgrade branch from 0444157 to a852878 Compare February 2, 2019 17:49

Darksonn mentioned this pull request Feb 3, 2019

Move src/theme to the root of the repository. #523

Closed

Havvy self-requested a review March 25, 2019 07:13

ehuss closed this Jul 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrades for mdbook 0.2.0, and link style cleanup. #391

Upgrades for mdbook 0.2.0, and link style cleanup. #391

alercah commented Aug 7, 2018

Havvy left a comment

Havvy commented Aug 9, 2018

Havvy commented Sep 20, 2018

alercah commented Jan 27, 2019

alercah commented Jan 27, 2019

ehuss commented Jan 28, 2019

ehuss commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

alercah commented Jan 29, 2019

ehuss left a comment

ehuss Jan 29, 2019

steveklabnik Jan 29, 2019

steveklabnik commented Jan 29, 2019 •

edited

Loading

steveklabnik commented Jan 29, 2019

steveklabnik commented Jan 30, 2019

alercah commented Feb 2, 2019

ehuss commented Feb 2, 2019

ehuss commented Feb 3, 2019

mati865 commented Jul 7, 2019

ehuss commented Jul 7, 2019

ehuss commented Jul 16, 2019

Upgrades for mdbook 0.2.0, and link style cleanup. #391

Upgrades for mdbook 0.2.0, and link style cleanup. #391

Conversation

alercah commented Aug 7, 2018

Havvy left a comment

Choose a reason for hiding this comment

Havvy commented Aug 9, 2018

Havvy commented Sep 20, 2018

alercah commented Jan 27, 2019

alercah commented Jan 27, 2019

ehuss commented Jan 28, 2019

ehuss commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

steveklabnik commented Jan 28, 2019

alercah commented Jan 29, 2019

ehuss left a comment

Choose a reason for hiding this comment

ehuss Jan 29, 2019

Choose a reason for hiding this comment

steveklabnik Jan 29, 2019

Choose a reason for hiding this comment

steveklabnik commented Jan 29, 2019 • edited Loading

steveklabnik commented Jan 29, 2019

steveklabnik commented Jan 30, 2019

alercah commented Feb 2, 2019

ehuss commented Feb 2, 2019

ehuss commented Feb 3, 2019

mati865 commented Jul 7, 2019

ehuss commented Jul 7, 2019

ehuss commented Jul 16, 2019

steveklabnik commented Jan 29, 2019 •

edited

Loading