Documentation fix for broken links in User Docs #5182

antonhibl · 2023-04-12T20:19:00Z

Fix some of the broken links, as mentioned in #5180, in the user documentation.

Description

Most links in the documentation used the old resource link which was USGS-Astrogeology, the new
resource link is DOI-USGS.

Related Issue

#5180

How Has This Been Validated?

Small link changes, this shouldn't probably be merged until v8.0.0 I would Imagine

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Documentation change (update to the documentation; no code change)
Breaking change (fix or feature that would cause existing functionality to change)
Infrastructure change (changes to things like CI or the build system that do not impact users)

Checklist:

I have read and agree to abide by the Code of Conduct
I have read the CONTRIBUTING document.
My change requires a change to the documentation and I have updated the documentation accordingly.
I have added tests to cover my changes.
I have added myself to the .zenodo.json document.
I have added any user impacting changes to the CHANGELOG.md document.

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

thareUSGS · 2023-04-14T18:51:43Z

isis/src/docsys/build/UserExplore.xsl

@@ -145,7 +145,7 @@ Deborah Lee Soltesz
          <td style="width:50%">
            <dl>
              <dt><h4>About ISIS Applications</h4></dt>
-              <dd><a href="https://usgs-astrogeology.github.io/ISIS3/ISIS_Cube_Format.html">
+              <dd><a href="https://isis.astrogeology.usgs.gov/documents/CommandLine/CommandLine.html">


This looks to be the oddball link pointing to the original site. Should this page be tagged to be moved to GitHub?

I'm not seeing a direct analogue to this page on the github pages. The closest thing I can find is https://github.com/DOI-USGS/ISIS3/wiki/Introduction_to_ISIS#Reserved-Command-Line-Arguments- This section and the subsequent sections seem to do a pretty good job of covering command line usage.

Even if it's not a direct copy of the previous docs, I think https://github.com/DOI-USGS/ISIS3/wiki/Introduction_to_ISIS#Reserved-Command-Line-Arguments- is where we should be linking. I'd say for consistency's sake we should be targeting all GitHub docs.

If the information at the github location is not sufficient, then content/documentation should be added to the new docs rather than directing users to the old docs.

I might be misunderstanding, should this link be changed again or is it good?

thareUSGS

Besides that one original link, all others look good.

isis/src/docsys/build/UserLearn.xsl

AustinSanders · 2023-04-14T20:10:12Z

isis/src/docsys/build/UserExplore.xsl

@@ -145,7 +145,7 @@ Deborah Lee Soltesz
          <td style="width:50%">
            <dl>
              <dt><h4>About ISIS Applications</h4></dt>
-              <dd><a href="https://usgs-astrogeology.github.io/ISIS3/ISIS_Cube_Format.html">
+              <dd><a href="https://isis.astrogeology.usgs.gov/documents/CommandLine/CommandLine.html">


I'm not seeing a direct analogue to this page on the github pages. The closest thing I can find is https://github.com/DOI-USGS/ISIS3/wiki/Introduction_to_ISIS#Reserved-Command-Line-Arguments- This section and the subsequent sections seem to do a pretty good job of covering command line usage.

AustinSanders · 2023-05-05T22:32:41Z

isis/src/docsys/build/UserExplore.xsl

@@ -145,7 +145,7 @@ Deborah Lee Soltesz
          <td style="width:50%">
            <dl>
              <dt><h4>About ISIS Applications</h4></dt>
-              <dd><a href="https://usgs-astrogeology.github.io/ISIS3/ISIS_Cube_Format.html">
+              <dd><a href="https://isis.astrogeology.usgs.gov/documents/CommandLine/CommandLine.html">


Even if it's not a direct copy of the previous docs, I think https://github.com/DOI-USGS/ISIS3/wiki/Introduction_to_ISIS#Reserved-Command-Line-Arguments- is where we should be linking. I'd say for consistency's sake we should be targeting all GitHub docs.

If the information at the github location is not sufficient, then content/documentation should be added to the new docs rather than directing users to the old docs.

antonhibl · 2023-05-25T21:34:28Z

@AustinSanders fixed the CLI link, this could be ready to merge.

* Update photomet's MinnaertEmpirical model to handle PVL input in photemplate format. Fixes #3621. (#5175) * Update photomet's MinnaertEmpirical model to handle PVL input in photemplate format * Updated CHANGELOG * changed description for tgocassisrdrgen to be more descriptive than before (#5167) * changed description for tgocassisrdrgen to be more descriptive than before. * modifying the changelog to reflect doc changes * fix typo * Documentation fix for broken links in User Docs (#5182) * doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications * Update to Ale 0.9.0 (#5209) * Update to Ale 0.9.0 * Updated to ALE 0.9.1 * Updated changelog --------- Co-authored-by: acpaquette <[email protected]> * Updated meta.yaml to reflect 8.0.0 release (#5203) * Updated meta.yaml to reflect 8.0.0 release * Updated changelog --------- Co-authored-by: acpaquette <[email protected]> * Test autolabeler --------- Co-authored-by: Anton Hibl <[email protected]> Co-authored-by: Amy Stamile <[email protected]> Co-authored-by: acpaquette <[email protected]> Co-authored-by: Austin Sanders <[email protected]>

* Update photomet's MinnaertEmpirical model to handle PVL input in photemplate format. Fixes #3621. (#5175) * Update photomet's MinnaertEmpirical model to handle PVL input in photemplate format * Updated CHANGELOG * changed description for tgocassisrdrgen to be more descriptive than before (#5167) * changed description for tgocassisrdrgen to be more descriptive than before. * modifying the changelog to reflect doc changes * fix typo * Documentation fix for broken links in User Docs (#5182) * doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications * Update to Ale 0.9.0 (#5209) * Update to Ale 0.9.0 * Updated to ALE 0.9.1 * Updated changelog --------- Co-authored-by: acpaquette <[email protected]> * Updated meta.yaml to reflect 8.0.0 release (#5203) * Updated meta.yaml to reflect 8.0.0 release * Updated changelog --------- Co-authored-by: acpaquette <[email protected]> * Test autolabeler * Try linking og issue --------- Co-authored-by: Anton Hibl <[email protected]> Co-authored-by: Amy Stamile <[email protected]> Co-authored-by: acpaquette <[email protected]> Co-authored-by: Austin Sanders <[email protected]>

* doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications

* Check if history blob buffer is null before executing memcpy (#5205) * Check if history blob buffer is null before executing memcpy * Updated CHANGELOG * changed description for tgocassisrdrgen to be more descriptive than before (#5167) * changed description for tgocassisrdrgen to be more descriptive than before. * modifying the changelog to reflect doc changes * fix typo * Documentation fix for broken links in User Docs (#5182) * doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications * Removed version specification from conda install command (#5236) * Clean Build Warnings (#5257) * std::unary/binary_function to std:::function * sprintf -> snprintf * vsprintf -> vsnprintf * fixed misc warnings * bypass jenkins error * Cmake mac 13 (#5261) * added quotes to Utilities.cmake * Added config for mac 13.4 * updated config to target macos13.5 * Segfault fix and tests (#5262) * fixed map definition reference link (#5265) * Update geos to 3.11.1 (#5266) * Update geos to 3.11.1 * Fixed failing test * fixes rclone recopying existing kernels (#5255) * fixes rclone duplication * updated changelog * Updated script * Addressed PR feedback * cubeit attribute fix (#5268) * cubeit attribute fix * Update changelog * Convert cholmod 32 bit to 64 bit calls (#5267) * Updated cholmod calls to 64 bit * changed int triple indices to long * Fixed errorpropagation cholmod call * Updated changelog * Campt attribute fix (#5269) * Prevent cube manager from setting the virtual band * Pass potential cube attributes through to the cube manager in campt * Added changelog entry * Fixed change log entry * Updated environment test --------- Co-authored-by: Christine Kim <[email protected]> Co-authored-by: Anton Hibl <[email protected]> Co-authored-by: Austin Sanders <[email protected]> Co-authored-by: Amy Stamile <[email protected]> Co-authored-by: Jacob Cain <[email protected]>

* Check if history blob buffer is null before executing memcpy (DOI-USGS#5205) * Check if history blob buffer is null before executing memcpy * Updated CHANGELOG * changed description for tgocassisrdrgen to be more descriptive than before (DOI-USGS#5167) * changed description for tgocassisrdrgen to be more descriptive than before. * modifying the changelog to reflect doc changes * fix typo * Documentation fix for broken links in User Docs (DOI-USGS#5182) * doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications * Removed version specification from conda install command (DOI-USGS#5236) * Clean Build Warnings (DOI-USGS#5257) * std::unary/binary_function to std:::function * sprintf -> snprintf * vsprintf -> vsnprintf * fixed misc warnings * bypass jenkins error * Cmake mac 13 (DOI-USGS#5261) * added quotes to Utilities.cmake * Added config for mac 13.4 * updated config to target macos13.5 * Segfault fix and tests (DOI-USGS#5262) * fixed map definition reference link (DOI-USGS#5265) * Update geos to 3.11.1 (DOI-USGS#5266) * Update geos to 3.11.1 * Fixed failing test * fixes rclone recopying existing kernels (DOI-USGS#5255) * fixes rclone duplication * updated changelog * Updated script * Addressed PR feedback * cubeit attribute fix (DOI-USGS#5268) * cubeit attribute fix * Update changelog * Convert cholmod 32 bit to 64 bit calls (DOI-USGS#5267) * Updated cholmod calls to 64 bit * changed int triple indices to long * Fixed errorpropagation cholmod call * Updated changelog * Campt attribute fix (DOI-USGS#5269) * Prevent cube manager from setting the virtual band * Pass potential cube attributes through to the cube manager in campt * Added changelog entry * Fixed change log entry * Updated environment test --------- Co-authored-by: Christine Kim <[email protected]> Co-authored-by: Anton Hibl <[email protected]> Co-authored-by: Austin Sanders <[email protected]> Co-authored-by: Amy Stamile <[email protected]> Co-authored-by: Jacob Cain <[email protected]>

* Check if history blob buffer is null before executing memcpy (#5205) * Check if history blob buffer is null before executing memcpy * Updated CHANGELOG * changed description for tgocassisrdrgen to be more descriptive than before (#5167) * changed description for tgocassisrdrgen to be more descriptive than before. * modifying the changelog to reflect doc changes * fix typo * Documentation fix for broken links in User Docs (#5182) * doc changes for new links, need to scan other files for the same * fixed remaining links * typo * fixed command line references link for ISIS3 Applications * Removed version specification from conda install command (#5236) * Clean Build Warnings (#5257) * std::unary/binary_function to std:::function * sprintf -> snprintf * vsprintf -> vsnprintf * fixed misc warnings * bypass jenkins error * Cmake mac 13 (#5261) * added quotes to Utilities.cmake * Added config for mac 13.4 * updated config to target macos13.5 * Segfault fix and tests (#5262) * fixed map definition reference link (#5265) * Update geos to 3.11.1 (#5266) * Update geos to 3.11.1 * Fixed failing test * fixes rclone recopying existing kernels (#5255) * fixes rclone duplication * updated changelog * Updated script * Addressed PR feedback * cubeit attribute fix (#5268) * cubeit attribute fix * Update changelog * Convert cholmod 32 bit to 64 bit calls (#5267) * Updated cholmod calls to 64 bit * changed int triple indices to long * Fixed errorpropagation cholmod call * Updated changelog * Campt attribute fix (#5269) * Prevent cube manager from setting the virtual band * Pass potential cube attributes through to the cube manager in campt * Added changelog entry * Fixed change log entry * Updated environment test --------- Co-authored-by: Christine Kim <[email protected]> Co-authored-by: Anton Hibl <[email protected]> Co-authored-by: Austin Sanders <[email protected]> Co-authored-by: Amy Stamile <[email protected]> Co-authored-by: Jacob Cain <[email protected]>

antonhibl and others added 4 commits April 12, 2023 13:12

doc changes for new links, need to scan other files for the same

eabce39

Merge branch 'DOI-USGS:dev' into documentation-fix

c56744a

fixed remaining links

6169011

Merge branch 'DOI-USGS:dev' into documentation-fix

6280915

thareUSGS reviewed Apr 14, 2023

View reviewed changes

thareUSGS previously approved these changes Apr 14, 2023

View reviewed changes

AustinSanders requested changes Apr 14, 2023

View reviewed changes

typo

af71ec7

antonhibl dismissed thareUSGS’s stale review via af71ec7 April 14, 2023 20:19

antonhibl requested a review from AustinSanders April 14, 2023 20:20

AustinSanders requested changes May 5, 2023

View reviewed changes

antonhibl and others added 2 commits May 25, 2023 14:32

fixed command line references link for ISIS3 Applications

e953e8f

Merge branch 'DOI-USGS:dev' into documentation-fix

3cbff41

antonhibl requested a review from AustinSanders May 25, 2023 21:34

AustinSanders approved these changes May 25, 2023

View reviewed changes

acpaquette merged commit 99fb8d2 into DOI-USGS:dev Jun 2, 2023

github-actions bot added the documentation label Jun 2, 2023

AustinSanders mentioned this pull request Jun 30, 2023

Command Line Reference documentation link for ISIS3 is bad #5180

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation fix for broken links in User Docs #5182

Documentation fix for broken links in User Docs #5182

antonhibl commented Apr 12, 2023

thareUSGS Apr 14, 2023

AustinSanders Apr 14, 2023

AustinSanders May 5, 2023

antonhibl May 5, 2023

thareUSGS left a comment •

edited

Loading

AustinSanders Apr 14, 2023

AustinSanders May 5, 2023

antonhibl commented May 25, 2023

Documentation fix for broken links in User Docs #5182

Documentation fix for broken links in User Docs #5182

Conversation

antonhibl commented Apr 12, 2023

Description

Related Issue

How Has This Been Validated?

Types of changes

Checklist:

Licensing

thareUSGS Apr 14, 2023

Choose a reason for hiding this comment

AustinSanders Apr 14, 2023

Choose a reason for hiding this comment

AustinSanders May 5, 2023

Choose a reason for hiding this comment

antonhibl May 5, 2023

Choose a reason for hiding this comment

thareUSGS left a comment • edited Loading

Choose a reason for hiding this comment

AustinSanders Apr 14, 2023

Choose a reason for hiding this comment

AustinSanders May 5, 2023

Choose a reason for hiding this comment

antonhibl commented May 25, 2023

thareUSGS left a comment •

edited

Loading