Skip to content
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

Fix 'getting started' internal links #7093

Merged
merged 1 commit into from
Jul 4, 2019

Conversation

tcharding
Copy link
Contributor

Currently the internal links do not work, the path is incorrect.

Update the path for internal links in the index file of 'getting started' section thereby fixing the links generated in HTML.

Currently the internal links do not work, the path is incorrect.

Update the path for internal links in the index file of 'getting started'
section thereby fixing the links generated in HTML.
@rust-highfive
Copy link

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ehuss (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 3, 2019
@tcharding
Copy link
Contributor Author

This is my first PR into cargo docs (and cargo in general). It seems this issue exists in other sections as well as just the 'getting started' section. Any time I find wide spread trivial mistakes my first thought is that I'm doing something wrong :) Perhaps I can state my workflow to see if the problem is with me. Thanks for your patience. I have built the cargo book with mdbook build and am serving it locally with mdbook serve and viewing the output HTML in a web browser. I am then doing the following in a loop:

  • hack
  • mdbook build; mdbook serve
  • view in browser

With this process, for me, this link issue exists. Thanks.

@alexcrichton
Copy link
Member

@bors: r+

Thanks!

@bors
Copy link
Contributor

bors commented Jul 4, 2019

📌 Commit 60f25f5 has been approved by alexcrichton

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 4, 2019
@bors
Copy link
Contributor

bors commented Jul 4, 2019

⌛ Testing commit 60f25f5 with merge 8ee5b09...

bors added a commit that referenced this pull request Jul 4, 2019
Fix 'getting started' internal links

Currently the internal links do not work, the path is incorrect.

Update the path for internal links in the index file of 'getting started' section thereby fixing the links generated in HTML.
@bors
Copy link
Contributor

bors commented Jul 4, 2019

☀️ Test successful - checks-travis, status-appveyor
Approved by: alexcrichton
Pushing 8ee5b09 to master...

@bors bors merged commit 60f25f5 into rust-lang:master Jul 4, 2019
@ehuss
Copy link
Contributor

ehuss commented Jul 5, 2019

Sorry for the confusion. Cargo still uses mdbook 0.1 which uses a different link style. I've been working on updating it, which will hopefully happen soon. Filed #7099 to revert this in the meantime.

bors added a commit that referenced this pull request Jul 5, 2019
Revert "Fix 'getting started' internal links"

This reverts commit 60f25f5 (#7093).

Cargo currently uses mdbook 0.1, so the links were correct.
bors added a commit to rust-lang/rust that referenced this pull request Jul 10, 2019
Update cargo

Update cargo

12 commits in 4c1fa54d10f58d69ac9ff55be68e1b1c25ecb816..677a180f4c8ca1dcef594f68dd0e63e4f08621f5
2019-06-24 11:24:18 +0000 to 2019-07-08 13:43:02 +0000
- Update dependencies (rust-lang/cargo#7106)
- Fix overwriting .d file for binary with dSYM on apple targets. (rust-lang/cargo#7057)
- Update changelog. (rust-lang/cargo#7102)
- Revert "Fix 'getting started' internal links" (rust-lang/cargo#7099)
- Bump to 0.39.0 (rust-lang/cargo#7100)
- Update dependency.rs (rust-lang/cargo#7098)
- Typo (rust-lang/cargo#7097)
- Fix 'getting started' internal links (rust-lang/cargo#7093)
- Fix misleading comment in testsuite (rust-lang/cargo#7090)
- improve uncommitted changes cargo-package message (rust-lang/cargo#7083)
- Clean environment when git-fetch-with-cli is used. (rust-lang/cargo#7082)
- Fix exponentiality in depend_on_deps_of_deps. (rust-lang/cargo#7062)
@ehuss ehuss added this to the 1.38.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants