Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen links for release #5140

Merged

Conversation

thewtex
Copy link
Member

@thewtex thewtex commented Jan 17, 2025

Update documentation doxygen links to point to ReadTheDocs.

In the documentation contributing documentation.
Point to the stable release on the ReadTheDocs CDN host.
These are now available for each release tag.
@github-actions github-actions bot added the area:Documentation Issues affecting the Documentation module label Jan 17, 2025
@thewtex thewtex requested a review from blowekamp January 17, 2025 21:49
@thewtex
Copy link
Member Author

thewtex commented Jan 17, 2025

Merging for the release.

@thewtex thewtex merged commit 9fd4b5a into InsightSoftwareConsortium:release Jan 17, 2025
7 of 8 checks passed
@jhlegarreta
Copy link
Member

jhlegarreta commented Jan 18, 2025

Sorry for my late review and thanks for taking care of all this, Matt.

IMHO, https://itk.org/Doxygen/html/index.html should be taken down to avoid confusing users. There is probably other links pointing to there that I am not aware of now that should be changed. @dzenanz. Thanks.

Edit: There is also https://insightsoftwareconsortium.github.io/ITKDoxygen/. Note that its tab name "ITK: Main Page", same as the one from https://itk.org/Doxygen/html/index.html, their favicons different, and tab names and favicons still different from https://docs.itk.org/projects/doxygen/en/stable/ ("ITK: Insight Toolkit"), and their default versions different (6.0.0 and 5.4.0).

@blowekamp
Copy link
Member

IMHO, https://itk.org/Doxygen/html/index.html should be taken down to avoid confusing users. There is probably other links pointing to there that I am not aware of now that should be changed. @dzenanz. Thanks.

This should be done carefully. I think there are a lot of links on the internet that point to the itk.org doxygen. Just taking the site down will make they all not work. Additionally, all these links add the to google search wait for ITK documentation. Some specific forwarding to the new docs.itk.org site should to be done to ensure internet linking continuity.

@thewtex
Copy link
Member Author

thewtex commented Jan 20, 2025

The links on docs.itk.org have all been updated, include the API link, the links here: https://docs.itk.org/en/latest/contributing/document_itk.html, and any class links.

@jhlegarreta
Copy link
Member

Thanks Matt 💯 ❤️.

@thewtex thewtex deleted the doxygen-links-for-release branch January 20, 2025 18:01
@dzenanz
Copy link
Member

dzenanz commented Jan 22, 2025

This is what Ian from Kitware Sysadmin team wrote:

In the apache config file for this site there are a pile of 301 redirect entrys that David O added for Matt M.
Some look similar to what you are referring to.

The more specific "old url" to "new url" you can provide the easier this will be.

Current Examples:

    #Added by David Owens -12-20-2019 for Matt McCormick
    Redirect 301 /ITK/help/documentation.html http://itk.org/
    Redirect 301 /ITK/project/welcome.html http://itk.org/
    Redirect 301 /ITK/project/about.html http://itk.org/about/
    Redirect 301 /ITK/project/parti.html http://itk.org/about/
    Redirect 301 /ITK/project/project.html http://itk.org/about/
    Redirect 301 /ITK/project/license.html http://itk.org/about/#license
    Redirect 301 /ITK/project/publications.html  http://itk.org/about/#citation
    Redirect 301 /ITK/project/statistics.html  https://github.com/InsightSoftwareConsortium/ITK/graphs/contributors
    Redirect 301 /ITK/project/press_kit.html http://itk.org/about//#logo
    Redirect 301 /ITK/project/getinvolved.html https://github.com/InsightSoftwareConsortium/ITK/blob/master/CONTRIBUTING.md
    Redirect 301 /ITK/project/contactus.html https://www.kitware.com/contact-us/
    Redirect 301 /ITK/resources/software.html  http://itk.org/download/
    Redirect 301 /ITK/resources/webinars.html  https://vimeo.com/kitware

I'm also seeing a significant number of Doxygen related redirects too

   # Aliases - added 12-26-2019 - David Owens
    alias /Doxygen /projects/Insight/WWW/InsightWeb/Doxygen
    alias /Doxygen10 /projects/Insight/WWW/InsightWeb/Doxygen10
    alias /Doxygen12 /projects/Insight/WWW/InsightWeb/Doxygen12
    alias /Doxygen14 /projects/Insight/WWW/InsightWeb/Doxygen14
    alias /Doxygen16 /projects/Insight/WWW/InsightWeb/Doxygen16
    alias /Doxygen310 /projects/Insight/WWW/InsightWeb/Doxygen310
    alias /Doxygen312 /projects/Insight/WWW/InsightWeb/Doxygen312
    alias /Doxygen314 /projects/Insight/WWW/InsightWeb/Doxygen314
    alias /Doxygen316 /projects/Insight/WWW/InsightWeb/Doxygen316
    alias /Doxygen318 /projects/Insight/WWW/InsightWeb/Doxygen318
    alias /Doxygen32 /projects/Insight/WWW/InsightWeb/Doxygen32
    alias /Doxygen320 /projects/Insight/WWW/InsightWeb/Doxygen320
    alias /Doxygen34 /projects/Insight/WWW/InsightWeb/Doxygen34
    alias /Doxygen36 /projects/Insight/WWW/InsightWeb/Doxygen36
    alias /Doxygen38 /projects/Insight/WWW/InsightWeb/Doxygen38
    alias /Doxygen40 /projects/Insight/WWW/InsightWeb/Doxygen40
    alias /Doxygen41 /projects/Insight/WWW/InsightWeb/Doxygen41
    alias /Doxygen410 /projects/Insight/WWW/InsightWeb/Doxygen410
    alias /Doxygen411 /projects/Insight/WWW/InsightWeb/Doxygen411
    alias /Doxygen412 /projects/Insight/WWW/InsightWeb/Doxygen412
    alias /Doxygen413 /projects/Insight/WWW/InsightWeb/Doxygen413
    alias /Doxygen42 /projects/Insight/WWW/InsightWeb/Doxygen42
    alias /Doxygen43 /projects/Insight/WWW/InsightWeb/Doxygen43
    alias /Doxygen44 /projects/Insight/WWW/InsightWeb/Doxygen44
    alias /Doxygen46 /projects/Insight/WWW/InsightWeb/Doxygen46
    alias /Doxygen48 /projects/Insight/WWW/InsightWeb/Doxygen48
    alias /Doxygen49 /projects/Insight/WWW/InsightWeb/Doxygen49
    alias /Doxygen50 /projects/Insight/WWW/InsightWeb/Doxygen50
    alias /Doxygen51 /projects/Insight/WWW/InsightWeb/Doxygen51
    alias /Doxygen52 /projects/Insight/WWW/InsightWeb/Doxygen52
    alias /Doxygen53 /projects/Insight/WWW/InsightWeb/Doxygen53

If we change your initial link (itk.org/Doxygen/html/) and make it a 301 redirect, then the above will most likely break. I think I saw that it was ok now that everything is over on readthedocs, but I just want to make sure. If this is ok then I'll enable the 301 (assuming I have the syntax right).

    # Redirects: Requested by Dzenan - 2025-01-21
    #
    # Redirect 301 /Doxygen/html/ http://docs.itk.org/projects/doxygen/en/stable/

@dzenanz
Copy link
Member

dzenanz commented Jan 22, 2025

@thewtex and others, does this redirect look right?

@thewtex
Copy link
Member Author

thewtex commented Jan 23, 2025

@dzenanz it would be:

Redirect 301 /Doxygen/html/ http://docs.itk.org/projects/doxygen/en/stable/
Redirect 301 /Doxygen10/html/ https://docs.itk.org/projects/doxygen/en/v1.0.0/
Redirect 301 /Doxygen12/html/ https://docs.itk.org/projects/doxygen/en/v1.2.0/
# etc.

@dzenanz
Copy link
Member

dzenanz commented Jan 27, 2025

All the redirects are in place and should now be active. Let us know if you see any issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants