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

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

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

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.

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.

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.

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.

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.

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.

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.

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