-
Notifications
You must be signed in to change notification settings - Fork 169
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
base: dev
Are you sure you want to change the base?
Conversation
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. |
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. |
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. |
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. |
isis/src/docsys/build/main.xsl
Outdated
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>. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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. |
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. |
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.
Related Issue
In response to #5666
How Has This Been Validated?
Built and tested locally with
ninja docs
andhttp-server
.Types of changes
Checklist:
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: