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

ISIS Application Docs style overhaul #5617

Merged
merged 14 commits into from
Oct 1, 2024

Conversation

jrcain-usgs
Copy link
Contributor

@jrcain-usgs jrcain-usgs commented Sep 21, 2024

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

  • 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_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.

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_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.

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_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.

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_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.

@jrcain-usgs jrcain-usgs marked this pull request as ready for review September 23, 2024 17:07
@jrcain-usgs jrcain-usgs changed the title ISIS Docs style overhaul ISIS Application Docs style overhaul Sep 23, 2024
@amystamile-usgs
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@amystamile-usgs
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

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.

@amystamile-usgs amystamile-usgs merged commit 636eb25 into DOI-USGS:dev Oct 1, 2024
2 checks passed
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