[PATCH] docs: rust: point directly to the standalone installers

[PATCH] docs: rust: point directly to the standalone installers

[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.

Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 Documentation/rust/quick-start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index 13b7744b1e27..253d47791f0f 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -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
-- 
2.39.2

Re: [PATCH] docs: rust: point directly to the standalone installers

[Miguel Ojeda]

On Mon, Mar 6, 2023 at 11:10 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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

Re: [PATCH] docs: rust: point directly to the standalone installers

[Vincenzo Palazzo]

> 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.
>
> Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---

Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

Re: [PATCH] docs: rust: point directly to the standalone installers

[Andreas Hindborg]

Miguel Ojeda <ojeda@kernel.org> writes:

> 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.
>
> Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---
>  Documentation/rust/quick-start.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
> index 13b7744b1e27..253d47791f0f 100644
> --- a/Documentation/rust/quick-start.rst
> +++ b/Documentation/rust/quick-start.rst
> @@ -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

Re: [PATCH] docs: rust: point directly to the standalone installers

[Miguel Ojeda]

On Tue, Mar 7, 2023 at 1:31 PM Andreas Hindborg <nmi@metaspace.dk> wrote:
>
> 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

Re: [PATCH] docs: rust: point directly to the standalone installers

[Miguel Ojeda]

On Tue, Mar 7, 2023 at 1:45 PM Miguel Ojeda
<miguel.ojeda.sandonis@gmail.com> wrote:
>
> 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

Re: [PATCH] docs: rust: point directly to the standalone installers

[Miguel Ojeda]

On Mon, Mar 6, 2023 at 11:10 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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.
>
> Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

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

Cheers,
Miguel