Skip to contentSkip to conversation

docs: rust: point directly to the standalone installers

PATCH Applied Miguel Ojeda 4 participants 7 messages Mar 6, 2023 – May 31, 2023

Subsystems (2)
lore
Share & tools
lore

Miguel Ojeda

author maintainer
#0 lore raw

PATCH 1/1 docs: rust: point directly to the standalone installers

The Quick Start guide points to the Rust programming language front page when it mentions the possibility of using the standalone installers instead of rustup.

This was done to have a hopefully stable link, but it is not too
helpful: readers need to figure out how to reach the standalone installers from there.

Thus point directly to the page (and anchor) with the table that contains the standalone installers (plus signing key etc.).

If the link breaks in the future, we can always update it as needed. And anyway having the full link includes the domain and gives more information about where the old docs were in such a broken link case, which may help.

---
 Documentation/rust/quick-start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/rust/quick-start.rst +1 -1
index 13b7744b1e27..253d47791f0f 100644
@@ -40,7 +40,7 @@ and run::
 
 Otherwise, fetch a standalone installer or install ``rustup`` from:
 
-	https://www.rust-lang.org
+	https://forge.rust-lang.org/infra/other-installation-methods.html#standalone
 
 
 Rust standard library source

base-commit: fe15c26ee26efa11741a7b632e9f23b01aca4cc6

Signature · 1 line
2.39.2
#1 lore raw
Quoted 3 lines · Miguel Ojeda

Thus point directly to the page (and anchor) with the table that contains the standalone installers (plus signing key etc.).

By the way, while it is fairly easy to figure out the links to previous stable releases, it would nevertheless be nice to have a way to show them. At least there is a FIXME comment in those docs about it:

    https://github.com/rust-lang/rust-forge/blob/793249870cf7610ffe78dcb9c7acc7efdbbcc713/src/infra/other-installation-methods.md?plain=1#L99-L101

So I opened https://github.com/rust-lang/rust-forge/issues/676.

Cheers,
Miguel

Reviewed-by on v1 1/1
#2 lore raw
In reply to Miguel Ojeda
Quoted 11 lines

The Quick Start guide points to the Rust programming language front page when it mentions the possibility of using the standalone installers instead of rustup.

This was done to have a hopefully stable link, but it is not too
helpful: readers need to figure out how to reach the standalone installers from there.

Thus point directly to the page (and anchor) with the table that contains the standalone installers (plus signing key etc.).

Quoted 8 lines

If the link breaks in the future, we can always update it as needed. And anyway having the full link includes the domain and gives more information about where the old docs were in such a broken link case, which may help.

---

#3 lore raw
In reply to Miguel Ojeda
Quoted 27 lines · Miguel Ojeda

The Quick Start guide points to the Rust programming language front page when it mentions the possibility of using the standalone installers instead of rustup.

This was done to have a hopefully stable link, but it is not too
helpful: readers need to figure out how to reach the standalone installers from there.

Thus point directly to the page (and anchor) with the table that contains the standalone installers (plus signing key etc.).

If the link breaks in the future, we can always update it as needed. And anyway having the full link includes the domain and gives more information about where the old docs were in such a broken link case, which may help.

---
 Documentation/rust/quick-start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/rust/quick-start.rst +0 -0
index 13b7744b1e27..253d47791f0f 100644

Documentation/rust/quick-start.rst and run:: · line 41

Quoted 2 lines
Documentation/rust/quick-start.rst +0 -0
@@ -40,7 +40,7 @@ and run::
 
 Otherwise, fetch a standalone installer or install ``rustup`` from:

I guess we should remove "or install ``rustup``" from this sentence?

BR Andreas

#4 lore raw
Quoted 2 lines · Andreas Hindborg

I guess we should remove "or install ``rustup``" from this sentence?

Good point -- the page contains installers for rustup itself too above the URL fragment, but we are pointing directly to the fragment, so it can be confusing.

I think I will split the sentence and add an extra link to the other fragment, since there is one for that too (#rustup).

Cheers,
Miguel

#5 lore raw
Quoted 3 lines · Miguel Ojeda

I think I will split the sentence and add an extra link to the other fragment, since there is one for that too (#rustup).

In the end, I did what you suggested Andreas; in part because their front page has slightly different instructions (opened
https://github.com/rust-lang/rust-forge/issues/684), and in part because adding extra links to rustup is better done in a different patch (perhaps explaining what rustup is, too).

Cheers,
Miguel

Applied
#6 lore raw
In reply to Miguel Ojeda
Quoted 12 lines · Miguel Ojeda

The Quick Start guide points to the Rust programming language front page when it mentions the possibility of using the standalone installers instead of rustup.

This was done to have a hopefully stable link, but it is not too
helpful: readers need to figure out how to reach the standalone installers from there.

Thus point directly to the page (and anchor) with the table that contains the standalone installers (plus signing key etc.).

Quoted 7 lines

If the link breaks in the future, we can always update it as needed. And anyway having the full link includes the domain and gives more information about where the old docs were in such a broken link case, which may help.

Applied to rust-next (with Andreas' suggestion applied) -- thanks everyone!

Cheers,
Miguel