user-documentation icon indicating copy to clipboard operation
user-documentation copied to clipboard
verified publisher icon JabRef

Fix dead links in the docs

Open koppor opened this issue 1 year ago • 4 comments

Some links are dead - see output of action: https://github.com/JabRef/user-documentation/actions/workflows/checks.yaml

Go through one by one and think

  • Is it available in the browser? Yes, then add it to https://github.com/JabRef/user-documentation/blob/main/.lycheeignore
  • Is it a temporary error? Yes, then leave as is
  • Check if there is another link for it.
    • For instance, the LICENCE.md file is now LICENSE
    • For the YouTube video, there is probably no replacement
    • In case there are "semantical" replacement, use them.
    • Check JabRef code and JabRef issues if the thing is really necessary. DiVa fetcher might not work - has to be checked
    • Missing images? -- Go back in history and check if the file was there - https://github.com/JabRef/user-documentation/commits/main/. See https://github.com/JabRef/user-documentation/issues/527#issuecomment-2416409999 for more hints

Summary

Status Count
🔍 Total 936
✅ Successful 873
⏳ Timeouts 2
🔀 Redirected 0
👻 Excluded 28
❓ Unknown 0
🚫 Errors 33

Errors per input

Errors in en/contributing/how-to-improve-the-help-page.md

Errors in en/cite/export-to-microsoft-word.md

Errors in en/advanced/license.md

Errors in en/collaborative-work/sqldatabase/README.md

Errors in en/advanced/how-to-expand-firstnames.md

  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-2.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-4.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-1.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-3.png | Failed: Cannot find file

Errors in en/faq/osx.md

Errors in en/advanced/xmp.md

Errors in en/faq/windows.md

Errors in en/installation.md

Errors in en/advanced/knowledge/medlineris.md

Errors in en/contributing/how-to-translate-the-ui.md

Errors in en/ai/ai-providers-and-api-keys.md

  • [ERROR] https://auth.mistral.ai/ui/login | Failed: Too many redirects: error following redirect for url (https://auth.mistral.ai/self-service/login/browser?aal=&refresh=&return_to=&organization=&via=)
  • [ERROR] https://console.mistral.ai/billing/subscribe/ | Failed: Too many redirects: error following redirect for url (https://auth.mistral.ai/self-service/login/browser?aal=&refresh=&return_to=&organization=&via=)
  • [ERROR] https://console.mistral.ai/api-keys/ | Failed: Too many redirects: error following redirect for url (https://auth.mistral.ai/self-service/login/browser?aal=&refresh=&return_to=&organization=&via=)

Errors in en/advanced/fields.md

Errors in en/related-work/related-work.md

Errors in en/setup/citationkeypatterns.md

  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/en/.gitbook/assets/optionspreferences%20(10).png | Failed: Cannot find file

Errors in en/faq/README.md

Errors in en/collect/import-using-online-bibliographic-database.md

Errors in en/collect/add-entry-using-an-id.md

Errors in en/finding-sorting-and-cleaning-entries/specialfields.md

  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/en/.gitbook/assets/specialfields-6columns-5.2%20(10).png | Failed: Cannot find file

Errors in en/collect/findunlinkedfiles.md

  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/contributing/how-to-improve-the-help-page.md#editing-help-pages-directly-in-the-browser | Failed: Cannot find file

koppor avatar Oct 17 '24 07:10 koppor

I think I'll round off my night by just working on this one; please assign :).

Tridecatrix avatar Oct 17 '24 07:10 Tridecatrix

Documentation changed in PR https://github.com/JabRef/user-documentation/pull/530 needs updating once this issue is resolved to remove the TEMPORARY NOTE.

Tridecatrix avatar Oct 17 '24 08:10 Tridecatrix

Actually, as a result of working on PR https://github.com/JabRef/user-documentation/pull/530 I don't think I'll have time for this tonight anymore, and I'm busy for the next few days (didn't intend to even work on this repo today, got sucked in; need to get back to work!!), so I think I'd better be unassigned again for now.

Tridecatrix avatar Oct 17 '24 09:10 Tridecatrix

didn't intend to even work on this repo today, got sucked in; need to get back to work!!),

Some here 😅

Happy working!

so I think I'd better be unassigned again for now.

Sure - I think, this issue cannot be fixed in one step - just many tiny little baby steps 😅

koppor avatar Oct 17 '24 09:10 koppor