DOI-USGS / ISIS3

Integrated Software for Imagers and Spectrometers v3. ISIS3 is a digital image processing software package to manipulate imagery collected by current and past NASA and International planetary missions.
https://isis.astrogeology.usgs.gov
Other
200 stars 168 forks source link

ISIS Application Docs style overhaul #5617

Closed jrcain-usgs closed 1 month ago

jrcain-usgs commented 1 month ago

Description

Updates the ISIS Application docs pages to modern styling, including required header and footer, as well as styling reflecting USWDS guidance.

Related Issue

5619

How Has This Been Validated?

Docs have been built and visited locally. In particular, the docs Homepage, TOCs, and random Application docs pages have been visited.

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:

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.

github-actions[bot] commented 1 month ago

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

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

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[bot] commented 1 month ago

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

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

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[bot] commented 1 month ago

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

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

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[bot] commented 1 month ago

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

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

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.

amystamile-usgs commented 1 month ago

It doesn't seem super clear that you can click the parameters to expand them. Would it be possible to add the down arrowhead simpler to the up arrowhead when it's expanded?

Screenshot 2024-09-30 at 9 12 40 AM Screenshot 2024-09-30 at 9 12 57 AM

jrcain-usgs commented 1 month ago

Hmm, what browser are you using? There is a down arrow that's supposed to be there, it shows up in my testing so far.

Line 34 of ISISApplicationDocStyle.css is meant to put it there:

    /* Change Expansion symbols */
    .acc-flex-head[aria-expanded="false"], .acc-flex-head[aria-expanded="false"]:hover {
      background-image: url(../../../../assets/img/usa-icons/expand_more.svg);
    }

I wonder if your browser doesn't recognize the [aria-expanded="false"] css condition for some reason?

jrcain-usgs commented 1 month ago

Is there a down arrow on the government "Here's how you know" banner at the top?

amystamile-usgs commented 1 month ago

Is there a down arrow on the government "Here's how you know" banner at the top?

No, that is missing as well for me.

amystamile-usgs commented 1 month ago

I checked my console and I am getting a CORs error for that particular svg. I am using Google Chrome.

Screenshot 2024-09-30 at 1 57 00 PM

amystamile-usgs commented 1 month ago

I do see the arrows on firefox for the parameters but not on the banner.

Screenshot 2024-09-30 at 2 02 32 PM

This may not be an issue once it is deployed in aws.

jrcain-usgs commented 1 month ago

I can't reproduce, all icons show up on Chrome and Firefox for me. Did you try your browser's hard reload (Cmd + Shift + R, I think)? I wonder if it cached a gov-banner from a different site where it's positioned slightly different? Really weird the inconsistency though, only up arrows work in chrome, down arrows in parameters but not banner in Firefox.

Are you building the docs differently than me? From ~/ISIS3/build I do:

ninja docs -j7
cd docs #(or cd docs/8.3.0)
http-server
amystamile-usgs commented 1 month ago

I can't reproduce, all icons show up on Chrome and Firefox for me. Did you try your browser's hard reload (Cmd + Shift + R, I think)? I wonder if it cached a gov-banner from a different site where it's positioned slightly different? Really weird the inconsistency though, only up arrows work in chrome, down arrows in parameters but not banner in Firefox.

Are you building the docs differently than me? From ~/ISIS3/build I do:

ninja docs -j7
cd docs #(or cd docs/8.3.0)
http-server

That was my issue. I was just opening the index.html into a browser.