URLs in juju help are out of date

[Tim McNamara]

In Juju 2.6.5, we refer to old documentation URLs:

$ juju help bootstrap
...
Available keys for use with --config can be found here:
    https://jujucharms.com/stable/controllers-config
    https://jujucharms.com/stable/models-config
...

[Anastasia (anastasia-macmood)]

That's a good idea. I have come across another command that referred to jujucharms.com (I think it was controller-config or maybe model-config).

We should change the references to it in all commands. I'll rename the bug to reflect that.

[Peter Matulis (petermatulis)]

These kinds of bugs have been filed (and fixed?) before. See bug 1784701. At this time you may want to hold fire as a new domain affecting Juju docs is imminent: https://jaas.ai .

[Anastasia (anastasia-macmood)]

This is the reason why I am reluctant for us to have any URL references in command docs - these URL are subject to change which makes our help unreliable. Our help should be self-contained. We will discuss it internal to decide on the course of action.

[Peter Matulis (petermatulis)]

Anastasia, I agree. Including URLs in help all started with the `juju help` command. bug 1624677 also opened Pandora's Box. Although it is very tempting to include a URL "for more details" ultimately help and docs are distinct and should be kept separate. The help should be self-contained.

[Anastasia (anastasia-macmood)]

Peter,

I am glad we agree ;D

Referred bug was filed in 2016 and Juju world has evolved since. A lot of commands became interactive, for example.

So potentially we no longer have the need to link to outside information... Tim M has recently worked on command help that required more per-provider specific information and we have touched on the subject of linking say discourse page where applicable. I think we have settled on 'that's ok coz we are in control there too' but realistically we should be providing any command related information and usage within the command help.

Like I said, it is not always a clear cut and sometimes we digress but maybe it is a good time to re-look at all our command help. We might find that there are a few things that we no longer like/want/need.

[Jon Seager (jnsgruk)]

This issue is no longer present in recent versions of Juju. There was one link left, which is remedied by the following PR: https://github.com/juju/juju/pull/14045