allsky icon indicating copy to clipboard operation
allsky copied to clipboard

Documentation deadlinks

Open troublestarter opened this issue 1 year ago • 11 comments

Hi

I think there is some deadlink in the documentation

For exemple : on the main page: https://htmlpreview.github.io/?https://raw.githubusercontent.com/thomasjacquin/allsky/master/html/documentation/index.html

When you click on installing or configuring image

You arrive on such page: image

Can you confirm me it should not do that so i will reference below all deadlink.

Thanks

troublestarter avatar Feb 12 '24 20:02 troublestarter

Thanks for reporting it. I fixed the Wiki page on GitHub which still pointed to the old GitHub page which no longer exists and caused all the links to still point there.

I'll leave this Issue open for a while in case you find more dead links. FYI, we are considering getting rid of the Wiki so users would only be able to view the documentation via the "Allsky Documentation" link in the WebUI, so please use that when reviewing the documentation. Thanks.

EricClaeys avatar Feb 13 '24 02:02 EricClaeys

So if i understand clearly, you want the users to be able to use "Allsky Documentation" link in the local WebUI from the Pi ?

But note that also: On the main url : https://github.com/AllskyTeam/allsky The link to the documentation point to the old documentation with deadlinks ;) so should be linked to this one : https://htmlpreview.github.io/?https://github.com/AllskyTeam/allsky/master/html/documentation/index.html instead

image So from here, INSTALLING and CONFIGURING always deadlinks for exemple.

troublestarter avatar Feb 13 '24 07:02 troublestarter

  • On the local documentation from webui, i have a 404 error on this page: http://192.168.0.155/documentation/settings/allskyWebsite.html

image

  • We should have the public url here because 404 error image

  • We have no link on this one here: image

troublestarter avatar Feb 13 '24 07:02 troublestarter

@troublestarter, Users can currently view the documentation via the "Allsky Documentation" link in the WebUI which is on the Pi, which means it is local. They can see the same documentation via the Wiki link in GitHub. It's the GitHub documentation we are considering getting rid of.

I will take a look at the dead links.

EricClaeys avatar Feb 13 '24 15:02 EricClaeys

I will take a look at the dead links.

Sure. I'm waiting for your feedback

troublestarter avatar Feb 13 '24 15:02 troublestarter

Overlay page

http://192.168.0.155/documentation/overlays/overlays.html In yellow : to verify if a link should be present In red, 404 error image

Here appears has a link but not link provided image

Here not linked to the external website, 404 error image

Here not working link, site may be down or temporary unavailable, so it should be testted again: image

troublestarter avatar Feb 13 '24 22:02 troublestarter

Module page http://192.168.0.155/documentation/modules/modules.html

  • Replace the link with the good direct link (https://github.com/AllskyTeam/allsky-modules) image

troublestarter avatar Feb 13 '24 23:02 troublestarter

Constellation overlay page http://192.168.0.155/documentation/explanations/constellationOverlay.html

  • Link with 404 error image

troublestarter avatar Feb 13 '24 23:02 troublestarter

Other page: http://192.168.0.155/documentation/troubleshooting/other.html

  • 404 link for Reducing wear on your SDcard image

troublestarter avatar Feb 13 '24 23:02 troublestarter

FYI https://github.com/AllskyTeam/allsky/discussions/3426

troublestarter avatar Feb 14 '24 18:02 troublestarter

@EricClaeys

Still in issue with new documentation to gave me:

- Overlay page

image

then

image

- Modules page:

I suggest to have the direct good link (https://github.com/AllskyTeam/allsky-modules) image

- Other page

image

- Allskywebsite page (http://192.168.0.155/documentation/settings/allskyWebsite.html)

image

A scanning tool also report some little things: image

All the other links seems OK !

troublestarter avatar Feb 14 '24 19:02 troublestarter

https://github.com/AllskyTeam/allsky/discussions/3489

troublestarter avatar Mar 10 '24 23:03 troublestarter

@troublestarter, The link in your last post doesn't work. I do this all the time, too. A valid link in GitHub is

[click here](https://github.com/AllskyTeam/allsky/discussions/3489)

unfortunately, clicking on the chain link icon often does what it did for you:

[https://github.com/AllskyTeam/allsky/discussions/3489](url)

I think it works if you stand on your left foot and chant something LOL

EricClaeys avatar Mar 11 '24 06:03 EricClaeys

I believe all the dead links are fixed in the next release, so I'm closing this Issue.

EricClaeys avatar May 12 '24 21:05 EricClaeys

Perfect

troublestarter avatar May 13 '24 06:05 troublestarter