AllskyTeam / allsky

A Raspberry Pi operated Wireless Allsky Camera
MIT License
1.19k stars 180 forks source link

Documentation deadlinks #3423

Closed troublestarter closed 5 months ago

troublestarter commented 8 months ago

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

EricClaeys commented 8 months ago

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.

troublestarter commented 8 months ago

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 commented 8 months ago

image

EricClaeys commented 8 months ago

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

troublestarter commented 8 months ago

I will take a look at the dead links.

Sure. I'm waiting for your feedback

troublestarter commented 8 months ago

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 commented 8 months ago

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

troublestarter commented 8 months ago

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

troublestarter commented 8 months ago

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

troublestarter commented 8 months ago

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

troublestarter commented 8 months ago

@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 commented 7 months ago

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

EricClaeys commented 7 months ago

@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 commented 5 months ago

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

troublestarter commented 5 months ago

Perfect