Skip to content

Updating Links #485

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

Closed
Michael-F-Bryan opened this issue Nov 12, 2017 · 3 comments · Fixed by #489
Closed

Updating Links #485

Michael-F-Bryan opened this issue Nov 12, 2017 · 3 comments · Fixed by #489
Labels
A-Documentation Area: Documentation E-Easy Experience: Easy

Comments

@Michael-F-Bryan
Copy link
Contributor

After moving the repository (see #482) a bunch of links have become outdated.

A quick grep through the repo showed the following:

$rg azerupi     

Cargo.toml
6:documentation = "http://azerupi.github.io/mdBook/index.html"
7:repository = "https://github.com/azerupi/mdBook"

CONTRIBUTING.md
8:Use the [issue tracker](https://github.com/azerupi/mdBook/issues), no question is too simple.
9:If we don't respond in a couple of days, ping us @azerupi, @steveklabnik, @frewsxcv it might just be that we forgot. :wink:
14:[E-Easy issues](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
20:[A-JavaScript](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
21:[A-Style](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
22:[A-HTML](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-HTML) or
23:[A-Mobile](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Mobile).
44:   git clone https://github.com/azerupi/mdBook.git
58:[stylus files](https://github.com/azerupi/mdBook/tree/master/src/theme/stylus) and regenerate the CSS.

src/config.rs
165:            warn!("http://azerupi.github.io/mdBook/format/config.html");

ci/deploy.sh
31:git remote add upstream "https://[email protected]/azerupi/mdBook.git"

src/utils/fs.rs
47:/// Consider [submitting a new issue](https://github.com/azerupi/mdBook/issues)
48:/// or a [pull-request](https://github.com/azerupi/mdBook/pulls) to improve it.

src/bin/mdbook.rs
39:                             at: https://github.com/azerupi/mdBook")

book-example/src/README.md
7:mdBook is free and open source, you can find the source code on [Github](https://github.com/azerupi/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/azerupi/mdBook/issues).

book-example/src/cli/watch.md
26:***note:*** *the `watch` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*

book-example/src/cli/serve.md
40:***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*

book-example/src/format/theme/syntax-highlighting.md
56:Feel free to [submit a new issue](https://github.com/azerupi/mdBook/issues) explaining what you have in mind and I will take a look at it.

book-example/src/format/theme/index-hbs.md
90:*If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/azerupi/mdBook/issues)

book-example/src/cli/cli-tool.md
27:The **[git version](https://github.com/azerupi/mdBook)** contains all the latest bug-fixes and features, that will be released in the next version on **Crates.io**, if you can't wait until the next release. You can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.
30:git clone --depth=1 https://github.com/azerupi/mdBook.git

README.md
7:            <a href="https://travis-ci.org/azerupi/mdBook"><img src="https://travis-ci.org/azerupi/mdBook.svg?branch=master"></a>
13:            <a href="https://ci.appveyor.com/project/azerupi/mdbook/"><img src="https://ci.appveyor.com/api/projects/status/o38racsnbcospyc8/branch/master?svg=true"></a>
19:            <a href="LICENSE"><img src="https://img.shields.io/github/license/azerupi/mdBook.svg"></a>
29:The [**Documentation**](http://azerupi.github.io/mdBook/) for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.
36:   Binaries are available for download [here](https://github.com/azerupi/mdBook/releases). Make sure to put the path to the binary into your `PATH`.
58:   cargo install --git https://github.com/azerupi/mdBook.git
66:   git clone https://github.com/azerupi/mdBook.git
82:Here are the main commands you will want to run. For a more exhaustive explanation, check out the [documentation](http://azerupi.github.io/mdBook/).
98:    Please, take a look at the [**Documentation**](http://azerupi.github.io/mdBook/cli/init.html) for more information and some neat tricks.
116:See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information.
122:If you are just starting out with Rust, there are a series of issus that are tagged [E-Easy](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy) and **we will gladly mentor you** so that you can successfully go through the process of fixing a bug or adding a new feature! Let us know if you need any help.
@anna-liao
Copy link
Contributor

@Michael-F-Bryan Is it just updating the links in the README? If so, I can work on this.

@anna-liao
Copy link
Contributor

Is https://docs.rs/mdbook/0.0.26/mdbook/ the only working link for mdbook? This is described as the API doc, so wondering if the original http://azerupi.github.io/mdBook/ is live at a different link?

@budziq
Copy link
Contributor

budziq commented Nov 17, 2017

Hi @anna-liao, Thanks for taking the interest!

Is it just updating the links in the README?

Actually It would be great to change all of the links also in:

  • source code (config.rs etc)
  • the book-example
  • cargo.toml
  • deploy.sh
  • any other place (grep for "azerupi" like @Michael-F-Bryan shown) in the bug report above.

Basically within all the links "azerupi" should be changed to "rust-lang-nursery" (except for appveyor which was not transitioned yet)
so

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation E-Easy Experience: Easy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants