jdaviz icon indicating copy to clipboard operation
jdaviz copied to clipboard

Making docs index match better with github 'About' description

Open bmorris3 opened this issue 1 year ago • 7 comments

Description

We just changed the About section of the repo from:

Screenshot 2024-12-05 at 11 54 51

to:

Screenshot 2024-12-05 at 11 54 51

This PR adjusts the main docs page to make it match more closely.

Change log entry

  • [ ] Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts, list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • [ ] Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • [ ] Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • [ ] Do the proposed changes follow the STScI Style Guides?
  • [ ] Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • [ ] Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • [ ] Did the CI pass? If not, are the failures related?
  • [ ] Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • [ ] After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

bmorris3 avatar Dec 05 '24 16:12 bmorris3

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.80%. Comparing base (3dc6573) to head (ba44ecb). Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3338      +/-   ##
==========================================
- Coverage   88.81%   88.80%   -0.01%     
==========================================
  Files         125      125              
  Lines       19041    19132      +91     
==========================================
+ Hits        16912    16991      +79     
- Misses       2129     2141      +12     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Dec 05 '24 17:12 codecov[bot]

I'm only two for four on those abbreviations. 🤷🏻‍♂️

bmorris3 avatar Dec 06 '24 14:12 bmorris3

I remember "Feel Free To Merge" but number 3 is escaping me.

rosteen avatar Dec 06 '24 14:12 rosteen

I am ok with changing the "about". How about adding in the docs something like: "Built for the James Webb Space Telescope, Jdaviz works with imaging and spectroscopic observations obtained with various telescopes".

camipacifici avatar Dec 06 '24 15:12 camipacifici

TQVM = thank you very much??

camipacifici avatar Dec 06 '24 15:12 camipacifici

"Built for the James Webb Space Telescope" might throw some people off, especially if they don't bother reading the rest of the sentence.

pllim avatar Dec 09 '24 15:12 pllim

Hmm why was this not merged?

pllim avatar Jan 15 '25 15:01 pllim