Skip to content

Conversation

@jrcain-usgs
Copy link
Contributor

@jrcain-usgs jrcain-usgs commented Nov 23, 2024

Description

The new Europa Clipper Image on the banner looks like it's from here or here. Those sources are subject to the JPL Image Use Policy. Though that policy is very permissive, it does not confirm that this image is in the public domain. I moved it into the asc-docs S3 bucket and linked to it there, so our banner will remain the same, but our repo won't have non-public-domain images.

Edited menu.xsl to reduce repetition.

Edited banner text to say that ISIS Application Manuals are still here.

Screenshot 2024-11-26 at 12 04 52

Related Issue

In response to #5666

How Has This Been Validated?

Built and tested locally with ninja docs and http-server.

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 my user impacting change 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.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

Comment on lines 91 to 94
Manuals for each ISIS Application <a href="{$menuPath}Application/index.html" target="_blank">remain here</a>,
as do docs for previous ISIS versions, accessible via the left panel.
All other ISIS documentation, including tutorials and guides,
is moving to <a href="https://astrogeology.usgs.gov/docs/" target="_blank">USGS Astrogeology Software Docs</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Some ISIS Docs Have Moved" I think is a good change, but this new paragraph is less clear than the original. I would suggest reverting it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be some mention that the manuals are still here (not just docs for past ISIS versions), although I can put the other part at the front.

The first version is repetitive. Essentially, tutorials and how-to guides are the same thing. Guides and usage explanations are also the same thing. Is there anything missing if I just say "tutorials and guides", or maybe "ISIS tutorials, guides, and concepts"? Both are more concise and sound better imo.

Is this any better?

ISIS documentation, including ISIS tutorials, guides, and concepts,
have been moved to USGS Astrogeology Software Docs.
Manuals for each ISIS Application remain here, as do docs
for previous ISIS versions, accessible via the left panel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm changing the name of the site from "ISIS Documentation" to "ISIS Application Manuals", since the manuals are all that will be here going forward.

Copy link
Collaborator

@Kelvinrr Kelvinrr Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tutorials and how-to guides are not the same thing, we explicitly separate them in our docs, so I don't agree it was repetitive.

I think the new one you linked here is good, we can go with that.

Can you update the description with a screenshot of that the site looks like, it'll save some time for reviewers when it comes to these doc updates.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@github-actions
Copy link

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5680".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@Kelvinrr Kelvinrr merged commit e7457b2 into DOI-USGS:dev Jan 3, 2025
2 checks passed
amystamile-usgs pushed a commit to amystamile-usgs/ISIS3 that referenced this pull request Apr 25, 2025
* move banner, not public domain

* delete moon-cr banner, unused

* use same list for front page and regular menu

* banner text - ISIS app manuals still here

* ISIS App manuals vs new docs wording

* grammar have -> has
amystamile-usgs added a commit that referenced this pull request Apr 25, 2025
* Move banner jpg out of repo to S3, not in public domain (#5680)

* move banner, not public domain

* delete moon-cr banner, unused

* use same list for front page and regular menu

* banner text - ISIS app manuals still here

* ISIS App manuals vs new docs wording

* grammar have -> has

* Menu Fixes to Isis Docs (#5734)

* Add in 9.0.0 menu option

---------

Co-authored-by: Jacob Cain <115182890+jrcain-usgs@users.noreply.github.com>
jrcain-usgs added a commit that referenced this pull request Dec 11, 2025
* Updates for 9.0.0 RC2 (#5706)

* Jigsaw Fixes (#5703)

* Add some fixes

* Update changelog

* Require update

* Test fix

* Version ticks for RC2

* Fix truth data for isis 9.0

* Moved bugfix version and rc back to appended string

---------

Co-authored-by: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>

* Changes for 9.0 (#5707)

* Updated build and run requirements with highfive

* Adjusted whitespace to be consistent with previous version

* remove the need to specify model and plugin (#5729)

* 9.0.0 Release Prep (#5773)

* Update environment.yml (#5742)

* Adds mkl to environment (#5747)

* kaguyatc2isis invalid BandBin values (#5692)

* Updates SpiceClient to handle redirect requests (#5696)

* Jigsaw Fixes (#5703)

* Add some fixes

* Update changelog

* Require update

* Test fix

* Fixed Cube::fromIsd to add "LineScanTimes" table from HRSC isds (#5705)

* in-progress-work

* convert table back to isis

* fix changelog

* Addressed PR feedback

* Fix segfault from spiceclient (#5735)

* Fix segfault from spiceclient

* Updated changelog

* getLocalNormal Reset (#5752)

* Fixes getlocalnormal to reset image sample and line

* Added changelog entry

* Updated changelog entry

* Fixes QView Min/Max bug (#5759)

* Add qview min max fix

* Update changelog

* Fixes Juno kernels download (#5754)

* Fixes Juno kernels download

* added changelog entry

* Embree Intersection Fix (#5769)

* Fixed embree intersection computation

* Fix embree local normal set and updated unittest

* Updated truth data for embree target and shape model tests

* Updated changelog

* Open up rounding in embree tests

* Updated embree target rounding to be more precise

* findFeaturesSegment fixes (#5768)

Co-authored-by: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>

* Updated changelog 9.0.0 release date

* Ticked versions to 9.0.0

* Add mktl to meta.yaml run section (#5749)

* Fixed bug where Lat/Lon/Radius point corrections are wrong in points.csv when running a rectangular (XYZ) bundle adjustment (#5688)

* Fixed bug in the method BundleSolutionInfo::outputPointsCSV() where, when performing a rectangular (XYZ) bundle adjustment, the Lat/Lon/Radius point corrections written to points.csv are incorrect and do not match those written to bundleout.txt. Also modified the ctest FunctionalTestJigsawBundleXYZ to spot check six lines (points) in points.csv. Addresses #5646.

* Removed unnecessary, duplicate calls to retrieve X,Y, and Z point :coordinates in method BundleSolutionInfo::outputPointsCSV. Addresses #5646.

* Adjusted spacing on some changelog entries

* Final Changelog updates from dev

* Pull in dev meta and env files

* Removed duplicate changelog entry

* Disable jigsaw save/apply feature

* Disabled jigsaw save/apply test

---------

Co-authored-by: Amy Stamile <74275278+amystamile-usgs@users.noreply.github.com>
Co-authored-by: Adam Paquette <acpaquette@usgs.gov>
Co-authored-by: kledmundson <6842706+kledmundson@users.noreply.github.com>

* 9.0.0 Docs Cherry-pick (#5778)

* Move banner jpg out of repo to S3, not in public domain (#5680)

* move banner, not public domain

* delete moon-cr banner, unused

* use same list for front page and regular menu

* banner text - ISIS app manuals still here

* ISIS App manuals vs new docs wording

* grammar have -> has

* Menu Fixes to Isis Docs (#5734)

* Add in 9.0.0 menu option

---------

Co-authored-by: Jacob Cain <115182890+jrcain-usgs@users.noreply.github.com>

* Jigsaw fix (#5771) (#5779)

* Save and write attributes

* Remove Polygon and CamStats tables during apply stage

* Update changelog

* Refactor to account only for existing keys

* Address feedback

Co-authored-by: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>

* 9.0.0_RC3 Release Prep (#5783)

* Re-enable jigsaw feature and test

* Update docs for 9.0.0_RC3 release

* GitHub Actions - Release Build (#5784) (#5789)

* Github Actions Release

* github release fixes

* update secret name

* Fixes tests

* Adds doc step and dev biweekly build

* Add in biweekly logic

* Update github-release.yml

* Update github-release.yml

* ISIS 9 release prep (#5907)

* readme change to trigger codebuild

* std namespace for isinf

* bump ale to 1.0.2

* Update FunctionalTestsSpiceinit.cpp to use clem_v21.tf (#5810)

* pin cspice and spiceypy

* trigger build

* some fixes

* Chandrayaan2 fixes and isisimport docs update (#5897)

* Chandrayaan2 fixes and isisimport docs update

* fix codebuild failures

* test changes and tolerances

* more tolerances

* tolerances pt2

* thmbasemap1 tols

* pin ale to 0.11.0

* pin ale 0.11.1

* meta.yaml ale 0.11.1

* code.json isis 9.0.0

* add missing section closer },

* regenerate authors isis 9.0.0

* match meta.yaml with environment.yml

* changelog date, fixes post-isis9_RC3

* Update CHANGELOG.md

---------

Co-authored-by: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>
Co-authored-by: Christine Kim <chkim@usgs.gov>
Co-authored-by: Amy Stamile <74275278+amystamile-usgs@users.noreply.github.com>

* cmake lists stable isis 9.0.0

* meta.yaml isis 9.0.0 build 0

* code.json date for 9 prod release

* update release runner to mac 14, 15

* don't label all other build LTS

---------

Co-authored-by: Austin Sanders <arsanders@usgs.gov>
Co-authored-by: Christine Kim <125395064+chkim-usgs@users.noreply.github.com>
Co-authored-by: Amy Stamile <74275278+amystamile-usgs@users.noreply.github.com>
Co-authored-by: Adam Paquette <acpaquette@usgs.gov>
Co-authored-by: kledmundson <6842706+kledmundson@users.noreply.github.com>
Co-authored-by: Christine Kim <chkim@usgs.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants