Remi-Gau
commented
1 year ago Interesting. I may need to deal with the permanent redirection of url some bids repo. Care to share your little helper?
Closed mih closed 1 year ago
Remi-Gau
commented
1 year ago Interesting. I may need to deal with the permanent redirection of url some bids repo. Care to share your little helper?
mih
commented
1 year ago It is included in https://github.com/datalad-handbook/book/pull/994
I have written a helper to check handbook URLs for a set of issues that I would consider worthwhile addressing.
The following issues are recognized:
redundant-trailing-slashThe same URL, but without the trailing slash, is used elsewhere in the book.unshorted-youtube-linkThis could be a https://youto.be/ style short URLneedless-trailing-slashA URL without a path component. It should need nbow trailing slashpermanent-redirectA permanent redirect is reported for a URLHere is a per-file list of URL issues in the current handbook sources:
docs/glossary.rst:permanent-redirect[https://docs.github.com/en/github/getting-started-with-github/fork-a-repo - permanently to https://docs.github.com/en/get-started/quickstart/fork-a-repo]permanent-redirect[https://try.github.io - permanently to https://docs.github.com/en/get-started/quickstart/set-up-git]permanent-redirect[https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent - permanently to https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent]docs/intro/howto.rst:redundant-trailing-slash[https://xkcd.com/1205/]docs/contributing.rst:needless-trailing-slash[https://allcontributors.org/]docs/intro/windows.rst:permanent-redirect[https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation#enable-long-paths-in-windows-10-version-1607-and-later - permanently to https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation#enable-long-paths-in-windows-10-version-1607-and-later]permanent-redirect[https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation - permanently to https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation]permanent-redirect[https://www.gnu.org/software/octave/ - permanently to https://octave.org/]permanent-redirect[https://docs.microsoft.com/en-us/windows/wsl/faq - permanently to https://learn.microsoft.com/en-us/windows/wsl/faq]needless-trailing-slash[https://forums.linuxmint.com/]permanent-redirect[https://uk.pcmag.com/adobe-photoshop-cc/124238/how-to-make-the-switch-from-windows-to-linux - permanently to https://uk.pcmag.com/linux/124238/how-to-make-the-switch-from-windows-to-linux]docs/extension_pkgs.rst:redundant-trailing-slash[https://osf.io/]needless-trailing-slash[https://osf.io/]redundant-trailing-slash[https://www.ukbiobank.ac.uk//]needless-trailing-slash[https://www.xnat.org/]redundant-trailing-slash[https://github.com/datalad/datalad-extensions/]docs/basics/101-105-install.rst:permanent-redirect[https://github.com/datalad-datasets/longnow-podcasts.git - permanently to https://github.com/datalad-datasets/longnow-podcasts]permanent-redirect[https://longnow.org/membership - permanently to https://longnow.org/join/]docs/basics/101-127-yoda.rst:permanent-redirect[http://phdcomics.com/comics/archive.php?comicid=1531 - permanently to https://phdcomics.com/comics/archive.php?comicid=1531]permanent-redirect[https://travis-ci.org - permanently to https://www.travis-ci.com/]permanent-redirect[https://the-turing-way.netlify.app/welcome - permanently to https://the-turing-way.netlify.app/index.html]docs/basics/101-130-yodaproject.rst:permanent-redirect[https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token - permanently to https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens]docs/basics/101-133-containersrun.rst:permanent-redirect[https://sylabs.io/guides/3.4/user-guide/installation.html - permanently to https://docs.sylabs.io/guides/3.4/user-guide/installation.html]permanent-redirect[https://sylabs.io/guides/3.4/user-guide/build_a_container.html - permanently to https://docs.sylabs.io/guides/3.4/user-guide/build_a_container.html]docs/basics/101-137-history.rst:permanent-redirect[https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - permanently to https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line]docs/basics/101-138-sharethirdparty.rst:permanent-redirect[https://dropbox.com - permanently to https://www.dropbox.com/]permanent-redirect[https://google.com - permanently to https://www.google.com/]permanent-redirect[https://git-lfs.github.com - permanently to https://git-lfs.com/]permanent-redirect[https://gitea.io/en-us - permanently to https://about.gitea.com/]docs/basics/101-139-dropbox.rst:permanent-redirect[https://github.com/DanielDent/git-annex-remote-rclone - permanently to https://github.com/git-annex-remote-rclone/git-annex-remote-rclone]permanent-redirect[http://git-annex.branchable.com/special_remotes - permanently to https://git-annex.branchable.com/special_remotes/]docs/basics/101-139-gitlfs.rst:permanent-redirect[https://docs.github.com/en/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage - permanently to https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage]permanent-redirect[https://docs.github.com/en/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage#git-lfs-objects-in-your-repository - permanently to https://docs.github.com/en/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage#git-lfs-objects-in-your-repository]docs/basics/101-139-hostingservices.rst:permanent-redirect[https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent - permanently to https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent]redundant-trailing-slash[https://developer.github.com/changes/2020-02-14-deprecating-password-auth/]docs/basics/101-139-privacy.rst:redundant-trailing-slash[https://git-annex.branchable.com/git-annex-wanted/]docs/basics/101-139-s3.rst:needless-trailing-slash[https://aws.amazon.com/]needless-trailing-slash[https://console.aws.amazon.com/]redundant-trailing-slash[https://git-annex.branchable.com/tips/public_Amazon_S3_remote/]redundant-trailing-slash[https://git-annex.branchable.com/special_remotes/]docs/basics/101-180-FAQ.rst:redundant-trailing-slash[https://git-annex.branchable.com/]needless-trailing-slash[https://git-annex.branchable.com/]needless-trailing-slash[https://www.datalad.org/]docs/beyond_basics/101-146-providers.rst:permanent-redirect[https://tools.ietf.org/html/rfc6750 - permanently to https://datatracker.ietf.org/doc/html/rfc6750]permanent-redirect[https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token - permanently to https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens]docs/beyond_basics/101-168-dvc.rst:permanent-redirect[https://github.com/datalad-handbook/data-version-control.git - permanently to https://github.com/datalad-handbook/data-version-control]docs/beyond_basics/101-170-dataladrun.rst:redundant-trailing-slash[https://www.ukbiobank.ac.uk/]needless-trailing-slash[https://www.ukbiobank.ac.uk/]docs/beyond_basics/101-182-catalog.rst:unshorted-youtube-link[https://www.youtube.com/watch?v=4GERwj49KFc]docs/code_from_chapters/ABCD.rst:permanent-redirect[https://studyforrest.org - permanently to https://www.studyforrest.org/]redundant-trailing-slash[https://www.docker.com/]needless-trailing-slash[https://www.docker.com/]permanent-redirect[https://sylabs.io/guides/3.5/user-guide/ - permanently to https://docs.sylabs.io/guides/3.5/user-guide/]docs/code_from_chapters/DLBasicsMPI.rst:redundant-trailing-slash[http://datasets.datalad.org/]needless-trailing-slash[http://datasets.datalad.org/]needless-trailing-slash[http://www.image-net.org/]permanent-redirect[http://www.image-net.org/ - permanently to https://image-net.org/]docs/code_from_chapters/OHBM_OSR.rst:unshorted-youtube-link[https://www.youtube.com/watch?v=ix3lC6HGo-Q&feature=youtu.be]docs/code_from_chapters/dgpa.rst:redundant-trailing-slash[https://github.com/ReproNim/containers/]redundant-trailing-slash[https://www.repronim.org/]needless-trailing-slash[https://www.repronim.org/]redundant-trailing-slash[https://gin.g-node.org/]needless-trailing-slash[https://gin.g-node.org/]needless-trailing-slash[http://singularity.lbl.gov/]permanent-redirect[http://singularity.lbl.gov/ - permanently to https://singularity.lbl.gov/]docs/code_from_chapters/neurohackademy.rst:redundant-trailing-slash[https://openneuro.org/]needless-trailing-slash[https://openneuro.org/]docs/extension_create.rst:needless-trailing-slash[https://www.appveyor.com/]needless-trailing-slash[https://codeclimate.com/]redundant-trailing-slash[https://readthedocs.org/]needless-trailing-slash[https://readthedocs.org/]docs/intro/executive_summary.rst:permanent-redirect[https://owncloud.org - permanently to https://owncloud.com/]docs/intro/filenaming.rst:permanent-redirect[https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file?redirectedfrom=MSDN#win32-file-namespaces - permanently to https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file?redirectedfrom=MSDN#win32-file-namespaces]redundant-trailing-slash[https://github.com/datalad-handbook/book/issues/new/]docs/intro/installation.rst:permanent-redirect[https://docs.microsoft.com/en-us/windows/wsl/install-win10 - permanently to https://learn.microsoft.com/en-us/windows/wsl/install]needless-trailing-slash[http://p7zip.sourceforge.net/]permanent-redirect[http://p7zip.sourceforge.net/ - permanently to https://p7zip.sourceforge.net/]docs/intro/philosophy.rst:redundant-trailing-slash[https://figshare.com/]needless-trailing-slash[https://figshare.com/]docs/usecases/HCP_dataset.rst:redundant-trailing-slash[https://research.cs.wisc.edu/htcondor/]redundant-trailing-slash[http://store.datalad.org/]needless-trailing-slash[http://store.datalad.org/]redundant-trailing-slash[https://keyring.readthedocs.io/en/latest/]docs/usecases/collaborative_data_management.rst:needless-trailing-slash[http://studyforrest.org/]permanent-redirect[http://studyforrest.org/ - permanently to https://www.studyforrest.org/]docs/usecases/encrypted_annex.rst:redundant-trailing-slash[https://git-annex.branchable.com/encryption/]needless-trailing-slash[https://gnupg.org/]docs/usecases/ml-analysis.rst:redundant-trailing-slash[https://numpy.org/]redundant-trailing-slash[https://pandas.pydata.org/]redundant-trailing-slash[https://scikit-image.org/]redundant-trailing-slash[https://scikit-learn.org/stable/]needless-trailing-slash[https://numpy.org/]needless-trailing-slash[https://pandas.pydata.org/]needless-trailing-slash[https://scikit-image.org/]redundant-trailing-slash[https://realpython.com/python-data-version-control/]docs/usecases/openneuro.rst:needless-trailing-slash[https://openfmri.org/]docs/usecases/reproducible-paper.rst:redundant-trailing-slash[https://github.com/datalad-handbook/repro-paper-sketch/]permanent-redirect[http://github.com/psychoinformatics-de/paper-remodnav/ - permanently to https://github.com/psychoinformatics-de/paper-remodnav/]docs/usecases/reproducible_neuroimaging_analysis.rst:needless-trailing-slash[https://www.dicomstandard.org/]needless-trailing-slash[https://nifti.nimh.nih.gov/]redundant-trailing-slash[https://singularity-hub.org/]needless-trailing-slash[https://singularity-hub.org/]needless-trailing-slash[http://fsl.fmrib.ox.ac.uk/]docs/usecases/reproducible_neuroimaging_analysis_simple.rst:needless-trailing-slash[https://legacy.openfmri.org/]redundant-trailing-slash[https://bids.neuroimaging.io/]needless-trailing-slash[https://bids.neuroimaging.io/]docs/usecases/using_globus_as_datastore.rst:redundant-trailing-slash[https://www.globus.org/]needless-trailing-slash[https://conp.ca/]needless-trailing-slash[https://www.globus.org/]needless-trailing-slash[https://git-scm.com/]needless-trailing-slash[https://orcid.org/]