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

Readme installation #5679

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Readme installation #5679

merged 6 commits into from
Dec 20, 2024

Conversation

jrcain-usgs
Copy link
Contributor

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

Reorganized the info in ISIS readme, moving some important info to ASC Docs, editing for conciseness, and removing unnecessary and overly verbose sections.

View proposed new README

Description

Extracted the Following Sections, moving each to its own ASC Doc page:

  • Installing ISIS
  • Setting Up the ISIS Data Area
  • ISIS Test Data

Condensed sections remaining on README for now:

  • RFC
  • System Requirements
  • Semantic Versioning

Updated section:

  • Citing ISIS (with current 8.3.0 version DOI)

Related Issue

Fixes #5500
Fixes #5650

How Has This Been Validated?

Readme previewed via VS Code markdown preview rendering.

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_5679".

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 self-assigned this Nov 22, 2024
@jrcain-usgs jrcain-usgs requested a review from Kelvinrr November 22, 2024 20:45
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_5679".

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

We can just change the logo like that, it would need to get reviewed by others first. I would argue to return it back to what it was and if we want to change it we can do something to update logos as a whole since some libraries might need ones.

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_5679".

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

Changed logo back.

The reason to consider a different one is readability.

In the old logo, the ISIS text and the image behind are right on top of each other, and have a lot of intersecting lines between them, which limits readability.

I changed it to brown for the ISIS docs to get better contrast, which helps but doesn't solve the root readability issue.

@Kelvinrr
Copy link
Collaborator

Kelvinrr commented Nov 23, 2024

@jrcain-usgs even if there are good reasons we need to have a conversation about these changes before they are worked, let alone merged. I would recommend also removing the logo from the PR.

Copy link
Collaborator

@Kelvinrr Kelvinrr left a comment

Choose a reason for hiding this comment

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

just some comments

README.md Outdated
is similar to the best practice usage of not adding any conda
packages to your 'base' conda environment.
- [Building ISIS](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/developing-isis3-with-cmake/)
- [ISIS Test Data](https://astrogeology.usgs.gov/docs/how-to-guides/isis-developer-guides/obtaining-maintaining-submitting-test-data/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need something that is a more general "this is how you run ISIS tests" not just how to install isis test data. Those linked docs cover it but maybe name this link "'How to run ISIS tests"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"How to run ISIS Tests" is currently under the "Building ISIS" Doc. Here's a small PR to link to "ISIS Test Data" from "Building ISIS." And with that, I can safely remove the ISIS Test Data link from the README.

README.md Outdated Show resolved Hide resolved
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_5679".

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_5679".

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 self-requested a review December 20, 2024 16:12
@Kelvinrr Kelvinrr merged commit 09cba88 into DOI-USGS:dev Dec 20, 2024
2 checks passed
@github-actions github-actions bot added bug Something isn't working documentation labels Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ISIS Docs Pruning Broke ISIS Logo in Readme Readme is long, duplicative, and verbose
2 participants